diff --git a/packages/parsers/src/openapi/3.1/extensions/XFernGlobalHeadersConverter.node.ts b/packages/parsers/src/openapi/3.1/extensions/XFernGlobalHeadersConverter.node.ts index 2af6481719..d9a0a8ed12 100644 --- a/packages/parsers/src/openapi/3.1/extensions/XFernGlobalHeadersConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/extensions/XFernGlobalHeadersConverter.node.ts @@ -45,6 +45,7 @@ export class XFernGlobalHeadersConverterNode extends BaseOpenApiV3_1ConverterNod context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: new Set(), }), ]; }); diff --git a/packages/parsers/src/openapi/3.1/paths/__test__/ExampleObjectConverter.node.test.ts b/packages/parsers/src/openapi/3.1/paths/__test__/ExampleObjectConverter.node.test.ts index 11e3f4a36d..17a501cb1e 100644 --- a/packages/parsers/src/openapi/3.1/paths/__test__/ExampleObjectConverter.node.test.ts +++ b/packages/parsers/src/openapi/3.1/paths/__test__/ExampleObjectConverter.node.test.ts @@ -51,7 +51,7 @@ describe("ExampleObjectConverterNode", () => { fields: { file: { multipartType: "file" }, }, - } as RequestMediaTypeObjectConverterNode, + } as unknown as RequestMediaTypeObjectConverterNode, responseBody: undefined, } ); diff --git a/packages/parsers/src/openapi/3.1/paths/__test__/request/MultipartFormDataPropertySchemaConverter.node.test.ts b/packages/parsers/src/openapi/3.1/paths/__test__/request/MultipartFormDataPropertySchemaConverter.node.test.ts index df25f0f9e1..f4d2496990 100644 --- a/packages/parsers/src/openapi/3.1/paths/__test__/request/MultipartFormDataPropertySchemaConverter.node.test.ts +++ b/packages/parsers/src/openapi/3.1/paths/__test__/request/MultipartFormDataPropertySchemaConverter.node.test.ts @@ -17,6 +17,7 @@ describe("MultipartFormDataPropertySchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(converter.multipartType).toBe("file"); @@ -38,6 +39,7 @@ describe("MultipartFormDataPropertySchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(converter.multipartType).toBe("files"); @@ -55,6 +57,7 @@ describe("MultipartFormDataPropertySchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(converter.multipartType).toBe("property"); @@ -80,6 +83,7 @@ describe("MultipartFormDataPropertySchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(converter.multipartType).toBe("file"); @@ -99,6 +103,7 @@ describe("MultipartFormDataPropertySchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(converter.multipartType).toBeUndefined(); @@ -118,6 +123,7 @@ describe("MultipartFormDataPropertySchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); const result = converter.convert(); diff --git a/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponseMediaTypeObjectConverter.node.test.ts b/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponseMediaTypeObjectConverter.node.test.ts index 37b386ebcc..4db212a6d6 100644 --- a/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponseMediaTypeObjectConverter.node.test.ts +++ b/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponseMediaTypeObjectConverter.node.test.ts @@ -24,7 +24,11 @@ describe("ResponseMediaTypeObjectConverterNode", () => { pathId: "test", }, "application/json", - undefined + undefined, + "test", + 200, + [], + {} ); expect(converter.contentType).toBe("application/json"); @@ -48,7 +52,11 @@ describe("ResponseMediaTypeObjectConverterNode", () => { pathId: "test", }, "application/octet-stream", - undefined + undefined, + "test", + 200, + [], + {} ); expect(converter.contentType).toBe("application/octet-stream"); @@ -73,7 +81,11 @@ describe("ResponseMediaTypeObjectConverterNode", () => { pathId: "test", }, "application/json", - "json" + "json", + "test", + 200, + [], + {} ); expect(converter.contentType).toBe("application/json"); @@ -92,7 +104,11 @@ describe("ResponseMediaTypeObjectConverterNode", () => { pathId: "test", }, "text/event-stream", - "sse" + "sse", + "test", + 200, + [], + {} ); const result = converter.convert(); @@ -110,7 +126,11 @@ describe("ResponseMediaTypeObjectConverterNode", () => { pathId: "test", }, "application/json", - undefined + undefined, + "test", + 200, + [], + {} ); expect(mockContext.errors.error).toHaveBeenCalledWith({ @@ -144,7 +164,11 @@ describe("ResponseMediaTypeObjectConverterNode", () => { pathId: "test", }, "application/json", - undefined + undefined, + "test", + 200, + [], + {} ); expect(converter.schema).toBeDefined(); diff --git a/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponseObjectConverter.node.test.ts b/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponseObjectConverter.node.test.ts index 0b9f6c3f52..7cdccd5529 100644 --- a/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponseObjectConverter.node.test.ts +++ b/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponseObjectConverter.node.test.ts @@ -20,12 +20,18 @@ describe("ResponseObjectConverterNode", () => { }, }; - const converter = new ResponseObjectConverterNode({ - input, - context: mockContext, - accessPath: [], - pathId: "test", - }); + const converter = new ResponseObjectConverterNode( + { + input, + context: mockContext, + accessPath: [], + pathId: "test", + }, + "test", + 200, + [], + {} + ); expect(converter.description).toBe("Success response"); expect(converter.responses).toBeDefined(); @@ -44,12 +50,18 @@ describe("ResponseObjectConverterNode", () => { }, }; - const converter = new ResponseObjectConverterNode({ - input, - context: mockContext, - accessPath: [], - pathId: "test", - }); + const converter = new ResponseObjectConverterNode( + { + input, + context: mockContext, + accessPath: [], + pathId: "test", + }, + "test", + 200, + [], + {} + ); expect(converter.headers).toBeDefined(); expect(converter.headers?.["X-Rate-Limit"]).toBeDefined(); @@ -74,12 +86,18 @@ describe("ResponseObjectConverterNode", () => { }, }; - const converter = new ResponseObjectConverterNode({ - input, - context: mockContext, - accessPath: [], - pathId: "test", - }); + const converter = new ResponseObjectConverterNode( + { + input, + context: mockContext, + accessPath: [], + pathId: "test", + }, + "test", + 200, + [], + {} + ); expect(converter.responses).toBeDefined(); expect(converter.responses?.length).toBe(1); @@ -90,12 +108,18 @@ describe("ResponseObjectConverterNode", () => { $ref: "#/components/responses/NonExistent", }; - new ResponseObjectConverterNode({ - input, - context: mockContext, - accessPath: [], - pathId: "test", - }); + new ResponseObjectConverterNode( + { + input, + context: mockContext, + accessPath: [], + pathId: "test", + }, + "test", + 200, + [], + {} + ); expect(mockContext.errors.error).toHaveBeenCalledWith({ message: "Undefined reference: #/components/responses/NonExistent", @@ -124,12 +148,18 @@ describe("ResponseObjectConverterNode", () => { }, }; - const converter = new ResponseObjectConverterNode({ - input, - context: mockContext, - accessPath: [], - pathId: "test", - }); + const converter = new ResponseObjectConverterNode( + { + input, + context: mockContext, + accessPath: [], + pathId: "test", + }, + "test", + 200, + [], + {} + ); const shapes = converter.convert(); expect(shapes).toBeDefined(); diff --git a/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponsesObjectConverter.node.test.ts b/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponsesObjectConverter.node.test.ts index 5899b80524..ebe7250063 100644 --- a/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponsesObjectConverter.node.test.ts +++ b/packages/parsers/src/openapi/3.1/paths/__test__/response/ResponsesObjectConverter.node.test.ts @@ -22,12 +22,17 @@ describe("ResponsesObjectConverterNode", () => { }, }; - const converter = new ResponsesObjectConverterNode({ - input, - context: mockContext, - accessPath: [], - pathId: "test", - }); + const converter = new ResponsesObjectConverterNode( + { + input, + context: mockContext, + accessPath: [], + pathId: "test", + }, + "test", + [], + {} + ); const result = converter.convert(); expect(result?.responses).toBeDefined(); @@ -60,7 +65,8 @@ describe("ResponsesObjectConverterNode", () => { pathId: "test", }, "testpath", - undefined + [], + {} ); const result = converter.convert(); @@ -90,12 +96,17 @@ describe("ResponsesObjectConverterNode", () => { }, }; - const converter = new ResponsesObjectConverterNode({ - input, - context: mockContext, - accessPath: [], - pathId: "test", - }); + const converter = new ResponsesObjectConverterNode( + { + input, + context: mockContext, + accessPath: [], + pathId: "test", + }, + "test", + [], + {} + ); const result = converter.convert(); expect(result?.responses[0]?.headers).toBeDefined(); @@ -118,12 +129,17 @@ describe("ResponsesObjectConverterNode", () => { }, }; - const converter = new ResponsesObjectConverterNode({ - input, - context: mockContext, - accessPath: [], - pathId: "test", - }); + const converter = new ResponsesObjectConverterNode( + { + input, + context: mockContext, + accessPath: [], + pathId: "test", + }, + "test", + [], + {} + ); const result = converter.convert(); expect(result?.responses).toBeDefined(); @@ -132,12 +148,17 @@ describe("ResponsesObjectConverterNode", () => { it("should handle empty responses", () => { const input: OpenAPIV3_1.ResponsesObject = {}; - const converter = new ResponsesObjectConverterNode({ - input, - context: mockContext, - accessPath: [], - pathId: "test", - }); + const converter = new ResponsesObjectConverterNode( + { + input, + context: mockContext, + accessPath: [], + pathId: "test", + }, + "test", + [], + {} + ); const result = converter.convert(); expect(result?.responses).toEqual([]); diff --git a/packages/parsers/src/openapi/3.1/paths/parameters/ParameterBaseObjectConverter.node.ts b/packages/parsers/src/openapi/3.1/paths/parameters/ParameterBaseObjectConverter.node.ts index 000a45be87..69e361e0f4 100644 --- a/packages/parsers/src/openapi/3.1/paths/parameters/ParameterBaseObjectConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/paths/parameters/ParameterBaseObjectConverter.node.ts @@ -77,6 +77,7 @@ export class ParameterBaseObjectConverterNode extends BaseOpenApiV3_1ConverterNo context: this.context, accessPath: this.accessPath, pathId: "schema", + seenSchemas: new Set(), }); // TODO: support multiple examples diff --git a/packages/parsers/src/openapi/3.1/paths/request/MultipartFormDataPropertySchemaConverter.node.ts b/packages/parsers/src/openapi/3.1/paths/request/MultipartFormDataPropertySchemaConverter.node.ts index 032285db5e..2aa0691eb3 100644 --- a/packages/parsers/src/openapi/3.1/paths/request/MultipartFormDataPropertySchemaConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/paths/request/MultipartFormDataPropertySchemaConverter.node.ts @@ -1,7 +1,7 @@ // This is not a real OAS type, it is used to encapsulate a large amount of logic import { OpenAPIV3_1 } from "openapi-types"; -import { BaseOpenApiV3_1ConverterNodeConstructorArgs } from "../../../BaseOpenApiV3_1Converter.node"; +import { BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs } from "../../../BaseOpenApiV3_1Converter.node"; import { ConstArrayToType, SUPPORTED_MULTIPART_TYPES, @@ -17,7 +17,7 @@ export class MultipartFormDataPropertySchemaConverterNode extends SchemaConverte contentType: string | undefined; constructor( - args: BaseOpenApiV3_1ConverterNodeConstructorArgs + args: BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs ) { super(args); this.safeParse(); diff --git a/packages/parsers/src/openapi/3.1/paths/request/RequestBodyObjectConverter.node.ts b/packages/parsers/src/openapi/3.1/paths/request/RequestBodyObjectConverter.node.ts index 4274721b5a..4d1f227828 100644 --- a/packages/parsers/src/openapi/3.1/paths/request/RequestBodyObjectConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/paths/request/RequestBodyObjectConverter.node.ts @@ -21,8 +21,7 @@ export class RequestBodyObjectConverterNode extends BaseOpenApiV3_1ConverterNode constructor( args: BaseOpenApiV3_1ConverterNodeConstructorArgs< OpenAPIV3_1.RequestBodyObject | OpenAPIV3_1.ReferenceObject - >, - protected path: string + > ) { super(args); this.safeParse(); @@ -53,8 +52,7 @@ export class RequestBodyObjectConverterNode extends BaseOpenApiV3_1ConverterNode accessPath: this.accessPath, pathId: "content", }, - contentType, - this.path + contentType ); } ); diff --git a/packages/parsers/src/openapi/3.1/paths/request/RequestMediaTypeObjectConverter.node.ts b/packages/parsers/src/openapi/3.1/paths/request/RequestMediaTypeObjectConverter.node.ts index f69453c31d..45c9650f70 100644 --- a/packages/parsers/src/openapi/3.1/paths/request/RequestMediaTypeObjectConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/paths/request/RequestMediaTypeObjectConverter.node.ts @@ -52,8 +52,7 @@ export class RequestMediaTypeObjectConverterNode extends BaseOpenApiV3_1Converte constructor( args: BaseOpenApiV3_1ConverterNodeConstructorArgs, - contentType: string | undefined, - protected path: string + contentType: string | undefined ) { super(args); this.safeParse(contentType); @@ -84,6 +83,7 @@ export class RequestMediaTypeObjectConverterNode extends BaseOpenApiV3_1Converte context: this.context, accessPath: this.accessPath, pathId: "schema", + seenSchemas: new Set(), }); } else if (mediaType?.isOctetStream()) { this.contentType = "bytes" as const; @@ -112,6 +112,7 @@ export class RequestMediaTypeObjectConverterNode extends BaseOpenApiV3_1Converte context: this.context, accessPath: this.accessPath, pathId: `schema.${key}`, + seenSchemas: new Set(), }), ]; }) diff --git a/packages/parsers/src/openapi/3.1/paths/response/ResponseMediaTypeObjectConverter.node.ts b/packages/parsers/src/openapi/3.1/paths/response/ResponseMediaTypeObjectConverter.node.ts index 4691a67a0f..9b6581a0b6 100644 --- a/packages/parsers/src/openapi/3.1/paths/response/ResponseMediaTypeObjectConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/paths/response/ResponseMediaTypeObjectConverter.node.ts @@ -198,6 +198,7 @@ export class ResponseMediaTypeObjectConverterNode extends BaseOpenApiV3_1Convert context: this.context, accessPath: this.accessPath, pathId: "type", + seenSchemas: new Set(), }); } } else if (mediaType?.isOctetStream()) { @@ -221,6 +222,7 @@ export class ResponseMediaTypeObjectConverterNode extends BaseOpenApiV3_1Convert context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: new Set(), }); } } @@ -264,6 +266,7 @@ export class ResponseMediaTypeObjectConverterNode extends BaseOpenApiV3_1Convert context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: new Set(), }).example(), }; diff --git a/packages/parsers/src/openapi/3.1/schemas/ArrayConverter.node.ts b/packages/parsers/src/openapi/3.1/schemas/ArrayConverter.node.ts index e764c0b572..2aa2cb3890 100644 --- a/packages/parsers/src/openapi/3.1/schemas/ArrayConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/schemas/ArrayConverter.node.ts @@ -1,8 +1,8 @@ import { OpenAPIV3_1 } from "openapi-types"; import { FernRegistry } from "../../../client/generated"; import { - BaseOpenApiV3_1ConverterNodeConstructorArgs, - BaseOpenApiV3_1ConverterNodeWithExample, + BaseOpenApiV3_1ConverterNodeWithTracking, + BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs, } from "../../BaseOpenApiV3_1Converter.node"; import { maybeSingleValueToArray } from "../../utils/maybeSingleValueToArray"; import { SchemaConverterNode } from "./SchemaConverter.node"; @@ -17,14 +17,14 @@ export declare namespace ArrayConverterNode { } } -export class ArrayConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample< +export class ArrayConverterNode extends BaseOpenApiV3_1ConverterNodeWithTracking< ArrayConverterNode.Input, ArrayConverterNode.Output[] | undefined > { item: SchemaConverterNode | undefined; constructor( - args: BaseOpenApiV3_1ConverterNodeConstructorArgs + args: BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs ) { super(args); this.safeParse(); @@ -36,6 +36,7 @@ export class ArrayConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample< context: this.context, accessPath: this.accessPath, pathId: "items", + seenSchemas: this.seenSchemas, }); if (this.input.items == null) { diff --git a/packages/parsers/src/openapi/3.1/schemas/ComponentsConverter.node.ts b/packages/parsers/src/openapi/3.1/schemas/ComponentsConverter.node.ts index 2e0ca6c0ce..03b74df104 100644 --- a/packages/parsers/src/openapi/3.1/schemas/ComponentsConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/schemas/ComponentsConverter.node.ts @@ -40,6 +40,7 @@ export class ComponentsConverterNode extends BaseOpenApiV3_1ConverterNode< context: this.context, accessPath: this.accessPath, pathId: key, + seenSchemas: new Set(), }), ]; }) diff --git a/packages/parsers/src/openapi/3.1/schemas/MixedSchemaConverter.node.ts b/packages/parsers/src/openapi/3.1/schemas/MixedSchemaConverter.node.ts index 073b3a8039..e432388f3d 100644 --- a/packages/parsers/src/openapi/3.1/schemas/MixedSchemaConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/schemas/MixedSchemaConverter.node.ts @@ -2,8 +2,8 @@ import { isNonNullish } from "@fern-api/ui-core-utils"; import { OpenAPIV3_1 } from "openapi-types"; import { FernRegistry } from "../../../client/generated"; import { - BaseOpenApiV3_1ConverterNodeConstructorArgs, - BaseOpenApiV3_1ConverterNodeWithExample, + BaseOpenApiV3_1ConverterNodeWithTracking, + BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs, } from "../../BaseOpenApiV3_1Converter.node"; import { maybeSingleValueToArray } from "../../utils/maybeSingleValueToArray"; import { SchemaConverterNode } from "./SchemaConverter.node"; @@ -16,7 +16,7 @@ export declare namespace MixedSchemaConverterNode { )[]; } -export class MixedSchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample< +export class MixedSchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithTracking< MixedSchemaConverterNode.Input, | FernRegistry.api.latest.TypeShape.UndiscriminatedUnion[] | FernRegistry.api.latest.TypeShape.Alias[] @@ -25,7 +25,7 @@ export class MixedSchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithEx nullable: boolean | undefined; constructor( - args: BaseOpenApiV3_1ConverterNodeConstructorArgs + args: BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs ) { super(args); this.parse(); @@ -42,6 +42,7 @@ export class MixedSchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithEx context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }); } return undefined; diff --git a/packages/parsers/src/openapi/3.1/schemas/ObjectConverter.node.ts b/packages/parsers/src/openapi/3.1/schemas/ObjectConverter.node.ts index 8d84c6d282..6c2d36758a 100644 --- a/packages/parsers/src/openapi/3.1/schemas/ObjectConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/schemas/ObjectConverter.node.ts @@ -2,8 +2,8 @@ import { isNonNullish } from "@fern-api/ui-core-utils"; import { OpenAPIV3_1 } from "openapi-types"; import { FernRegistry } from "../../../client/generated"; import { - BaseOpenApiV3_1ConverterNodeConstructorArgs, - BaseOpenApiV3_1ConverterNodeWithExample, + BaseOpenApiV3_1ConverterNodeWithTracking, + BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs, } from "../../BaseOpenApiV3_1Converter.node"; import { convertToObjectProperties } from "../../utils/3.1/convertToObjectProperties"; import { getSchemaIdFromReference } from "../../utils/3.1/getSchemaIdFromReference"; @@ -19,7 +19,7 @@ export declare namespace ObjectConverterNode { } } -export class ObjectConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample< +export class ObjectConverterNode extends BaseOpenApiV3_1ConverterNodeWithTracking< ObjectConverterNode.Input, ( | FernRegistry.api.latest.TypeShape.Object_ @@ -33,7 +33,7 @@ export class ObjectConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample requiredProperties: string[] | undefined; constructor( - args: BaseOpenApiV3_1ConverterNodeConstructorArgs + args: BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs ) { super(args); this.safeParse(); @@ -52,6 +52,7 @@ export class ObjectConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }), ]; }) @@ -68,6 +69,7 @@ export class ObjectConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }) : undefined; @@ -90,6 +92,7 @@ export class ObjectConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }), ]; } @@ -217,6 +220,7 @@ export class ObjectConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }), ]; } diff --git a/packages/parsers/src/openapi/3.1/schemas/OneOfConverter.node.ts b/packages/parsers/src/openapi/3.1/schemas/OneOfConverter.node.ts index 6975161dfa..82f88986e7 100644 --- a/packages/parsers/src/openapi/3.1/schemas/OneOfConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/schemas/OneOfConverter.node.ts @@ -2,14 +2,14 @@ import { isNonNullish } from "@fern-api/ui-core-utils"; import { OpenAPIV3_1 } from "openapi-types"; import { FernRegistry } from "../../../client/generated"; import { - BaseOpenApiV3_1ConverterNodeConstructorArgs, - BaseOpenApiV3_1ConverterNodeWithExample, + BaseOpenApiV3_1ConverterNodeWithTracking, + BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs, } from "../../BaseOpenApiV3_1Converter.node"; import { resolveSchemaReference } from "../../utils/3.1/resolveSchemaReference"; import { maybeSingleValueToArray } from "../../utils/maybeSingleValueToArray"; import { SchemaConverterNode } from "./SchemaConverter.node"; -export class OneOfConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample< +export class OneOfConverterNode extends BaseOpenApiV3_1ConverterNodeWithTracking< OpenAPIV3_1.NonArraySchemaObject, | [FernRegistry.api.latest.TypeShape.DiscriminatedUnion] | [FernRegistry.api.latest.TypeShape.UndiscriminatedUnion] @@ -23,7 +23,7 @@ export class OneOfConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample< undiscriminatedMapping: SchemaConverterNode[] | undefined; constructor( - args: BaseOpenApiV3_1ConverterNodeConstructorArgs + args: BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs ) { super(args); this.safeParse(); @@ -46,6 +46,7 @@ export class OneOfConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample< context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }); }); } else { @@ -75,6 +76,7 @@ export class OneOfConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample< context: this.context, accessPath: [...this.accessPath, "discriminator", "mapping", key], pathId: key, + seenSchemas: this.seenSchemas, }); }); } diff --git a/packages/parsers/src/openapi/3.1/schemas/ReferenceConverter.node.ts b/packages/parsers/src/openapi/3.1/schemas/ReferenceConverter.node.ts index 5500361d94..92c29b43ba 100644 --- a/packages/parsers/src/openapi/3.1/schemas/ReferenceConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/schemas/ReferenceConverter.node.ts @@ -1,14 +1,14 @@ import { OpenAPIV3_1 } from "openapi-types"; import { FernRegistry } from "../../../client/generated"; import { + BaseOpenApiV3_1ConverterNode, BaseOpenApiV3_1ConverterNodeConstructorArgs, - BaseOpenApiV3_1ConverterNodeWithExample, } from "../../BaseOpenApiV3_1Converter.node"; import { getSchemaIdFromReference } from "../../utils/3.1/getSchemaIdFromReference"; import { resolveSchemaReference } from "../../utils/3.1/resolveSchemaReference"; import { SchemaConverterNode } from "./SchemaConverter.node"; -export class ReferenceConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample< +export class ReferenceConverterNode extends BaseOpenApiV3_1ConverterNode< OpenAPIV3_1.ReferenceObject, FernRegistry.api.latest.TypeShape.Alias > { @@ -42,8 +42,8 @@ export class ReferenceConverterNode extends BaseOpenApiV3_1ConverterNodeWithExam value: { type: "id", id: FernRegistry.TypeId(this.schemaId), - // TODO: figure out how to handle default - default: undefined, + default: resolveSchemaReference(this.input, this.context.document) + ?.default, }, }; } @@ -58,7 +58,8 @@ export class ReferenceConverterNode extends BaseOpenApiV3_1ConverterNodeWithExam input: schema, context: this.context, accessPath: this.accessPath, - pathId: this.pathId, + pathId: this.input.$ref.split("/").pop() ?? "", + seenSchemas: new Set(), }).example(); } } diff --git a/packages/parsers/src/openapi/3.1/schemas/SchemaConverter.node.ts b/packages/parsers/src/openapi/3.1/schemas/SchemaConverter.node.ts index 5178683a78..c0ecc6a669 100644 --- a/packages/parsers/src/openapi/3.1/schemas/SchemaConverter.node.ts +++ b/packages/parsers/src/openapi/3.1/schemas/SchemaConverter.node.ts @@ -2,8 +2,9 @@ import { OpenAPIV3_1 } from "openapi-types"; import { UnreachableCaseError } from "ts-essentials"; import { FernRegistry } from "../../../client/generated"; import { - BaseOpenApiV3_1ConverterNodeConstructorArgs, BaseOpenApiV3_1ConverterNodeWithExample, + BaseOpenApiV3_1ConverterNodeWithTracking, + BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs, } from "../../BaseOpenApiV3_1Converter.node"; import { maybeSingleValueToArray } from "../../utils/maybeSingleValueToArray"; import { AvailabilityConverterNode } from "../extensions/AvailabilityConverter.node"; @@ -37,7 +38,7 @@ export type PrimitiveType = | BooleanConverterNode.Input | StringConverterNode.Input; -export class SchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample< +export class SchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithTracking< OpenAPIV3_1.SchemaObject | OpenAPIV3_1.ReferenceObject, | FernRegistry.api.latest.TypeShape | FernRegistry.api.latest.TypeShape[] @@ -58,7 +59,7 @@ export class SchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample availability: AvailabilityConverterNode | undefined; constructor( - args: BaseOpenApiV3_1ConverterNodeConstructorArgs< + args: BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs< OpenAPIV3_1.SchemaObject | OpenAPIV3_1.ReferenceObject > ) { @@ -67,6 +68,17 @@ export class SchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample } parse(): void { + if (!isReferenceObject(this.input)) { + if (this.accessPath.length >= 100 || this.seenSchemas.has(this.input)) { + this.context.errors.warning({ + message: "Circular or deeply nested schema found, terminating", + path: this.accessPath, + }); + return; + } + this.seenSchemas.add(this.input); + } + this.description = this.input.description; this.availability = new AvailabilityConverterNode({ input: this.input, @@ -104,6 +116,7 @@ export class SchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }); } else if ( isNonArraySchema(this.input) && @@ -114,6 +127,7 @@ export class SchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }); // here, isObjectSchema also supports null type } else if (isObjectSchema(this.input) && this.input.allOf != null) { @@ -123,6 +137,7 @@ export class SchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }); } else if (isNonArraySchema(this.input) && this.input.enum != null) { this.typeShapeNode = new EnumConverterNode({ @@ -142,6 +157,7 @@ export class SchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }); } break; @@ -152,6 +168,7 @@ export class SchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }); } break; @@ -215,6 +232,7 @@ export class SchemaConverterNode extends BaseOpenApiV3_1ConverterNodeWithExample context: this.context, accessPath: this.accessPath, pathId: this.pathId, + seenSchemas: this.seenSchemas, }); } } diff --git a/packages/parsers/src/openapi/3.1/schemas/__test__/ArrayConverter.node.test.ts b/packages/parsers/src/openapi/3.1/schemas/__test__/ArrayConverter.node.test.ts index 6895ad9132..a79e019010 100644 --- a/packages/parsers/src/openapi/3.1/schemas/__test__/ArrayConverter.node.test.ts +++ b/packages/parsers/src/openapi/3.1/schemas/__test__/ArrayConverter.node.test.ts @@ -21,6 +21,7 @@ describe("ArrayConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.item?.typeShapeNode).toBeInstanceOf(StringConverterNode); }); @@ -34,6 +35,7 @@ describe("ArrayConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(mockContext.errors.error).toHaveBeenCalledWith({ message: @@ -54,6 +56,7 @@ describe("ArrayConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); const converted = node.convert(); expect(converted).toEqual([ @@ -85,6 +88,7 @@ describe("ArrayConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); const converted = node.convert(); expect(mockContext.errors.error).toHaveBeenCalledWith({ diff --git a/packages/parsers/src/openapi/3.1/schemas/__test__/MixedSchemaConverter.node.test.ts b/packages/parsers/src/openapi/3.1/schemas/__test__/MixedSchemaConverter.node.test.ts index fc70350593..61687579b4 100644 --- a/packages/parsers/src/openapi/3.1/schemas/__test__/MixedSchemaConverter.node.test.ts +++ b/packages/parsers/src/openapi/3.1/schemas/__test__/MixedSchemaConverter.node.test.ts @@ -21,6 +21,7 @@ describe("MixedSchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.nullable).toBe(true); @@ -38,6 +39,7 @@ describe("MixedSchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.nullable).toBeUndefined(); @@ -57,6 +59,7 @@ describe("MixedSchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); const result = node.convert()[0]; @@ -78,6 +81,7 @@ describe("MixedSchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); const result = node.convert()[0]; @@ -95,6 +99,7 @@ describe("MixedSchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); node.typeNodes = undefined; diff --git a/packages/parsers/src/openapi/3.1/schemas/__test__/ObjectConverter.node.test.ts b/packages/parsers/src/openapi/3.1/schemas/__test__/ObjectConverter.node.test.ts index 8f6745634b..2c58d6d2f8 100644 --- a/packages/parsers/src/openapi/3.1/schemas/__test__/ObjectConverter.node.test.ts +++ b/packages/parsers/src/openapi/3.1/schemas/__test__/ObjectConverter.node.test.ts @@ -19,6 +19,7 @@ describe("ObjectConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.extends).toEqual([]); expect(node.properties).toEqual({}); @@ -38,6 +39,7 @@ describe("ObjectConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(Object.keys(node.properties ?? {})).toEqual(["name", "age"]); expect(node.properties?.name).toBeInstanceOf(SchemaConverterNode); @@ -58,6 +60,7 @@ describe("ObjectConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.extraProperties).toBeDefined(); const converted = node.convert()[0]?.extraProperties; @@ -77,6 +80,7 @@ describe("ObjectConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.extraProperties).toBeUndefined(); }); @@ -91,6 +95,7 @@ describe("ObjectConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.extraProperties).toBeInstanceOf(SchemaConverterNode); }); @@ -109,6 +114,7 @@ describe("ObjectConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); const converted = node.convert(); expect(converted).toEqual([ @@ -139,6 +145,7 @@ describe("ObjectConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); const converted = node.convert(); expect(converted).toEqual([ diff --git a/packages/parsers/src/openapi/3.1/schemas/__test__/OneOfConverter.node.test.ts b/packages/parsers/src/openapi/3.1/schemas/__test__/OneOfConverter.node.test.ts index acbc49c091..0c6c24b15c 100644 --- a/packages/parsers/src/openapi/3.1/schemas/__test__/OneOfConverter.node.test.ts +++ b/packages/parsers/src/openapi/3.1/schemas/__test__/OneOfConverter.node.test.ts @@ -35,6 +35,7 @@ describe("OneOfConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.discriminated).toBe(false); expect(node.undiscriminatedMapping?.length).toBe(2); @@ -56,6 +57,7 @@ describe("OneOfConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.discriminated).toBe(true); expect(node.discriminant).toBe("type"); @@ -80,6 +82,7 @@ describe("OneOfConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); const result = node.convert()[0]; expect(result?.type).toBe("discriminatedUnion"); @@ -99,6 +102,7 @@ describe("OneOfConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); const result = node.convert()[0]; expect(result?.type).toBe("undiscriminatedUnion"); @@ -158,6 +162,7 @@ describe("OneOfConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); const result = node.convert(); expect(result).toBeUndefined(); diff --git a/packages/parsers/src/openapi/3.1/schemas/__test__/ReferenceConverter.node.test.ts b/packages/parsers/src/openapi/3.1/schemas/__test__/ReferenceConverter.node.test.ts index 640b607408..330dacfbe9 100644 --- a/packages/parsers/src/openapi/3.1/schemas/__test__/ReferenceConverter.node.test.ts +++ b/packages/parsers/src/openapi/3.1/schemas/__test__/ReferenceConverter.node.test.ts @@ -19,6 +19,7 @@ describe("ReferenceConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.schemaId).toBe("Pet"); }); @@ -32,6 +33,7 @@ describe("ReferenceConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.schemaId).toBeUndefined(); expect(mockContext.errors.error).toHaveBeenCalledWith({ @@ -51,6 +53,7 @@ describe("ReferenceConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.convert()).toEqual({ type: "alias", @@ -71,6 +74,7 @@ describe("ReferenceConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.convert()).toBeUndefined(); }); diff --git a/packages/parsers/src/openapi/3.1/schemas/__test__/SchemaConverter.node.test.ts b/packages/parsers/src/openapi/3.1/schemas/__test__/SchemaConverter.node.test.ts index 4f1a0e3338..fc3de24a9c 100644 --- a/packages/parsers/src/openapi/3.1/schemas/__test__/SchemaConverter.node.test.ts +++ b/packages/parsers/src/openapi/3.1/schemas/__test__/SchemaConverter.node.test.ts @@ -21,6 +21,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.typeShapeNode).toBeInstanceOf(ReferenceConverterNode); }); @@ -37,6 +38,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.typeShapeNode).toBeInstanceOf(ObjectConverterNode); }); @@ -50,6 +52,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.typeShapeNode).toBeDefined(); }); @@ -63,6 +66,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.typeShapeNode).toBeDefined(); }); @@ -76,6 +80,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.typeShapeNode).toBeDefined(); }); @@ -89,6 +94,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.typeShapeNode).toBeDefined(); }); @@ -105,6 +111,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.typeShapeNode).toBeDefined(); }); @@ -119,6 +126,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.typeShapeNode).toBeDefined(); }); @@ -132,6 +140,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.typeShapeNode).toBeDefined(); }); @@ -148,6 +157,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.typeShapeNode).toBeDefined(); }); @@ -162,6 +172,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.description).toBe("test description"); }); @@ -177,6 +188,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); const result = node.convert(); expect(result).toEqual({ @@ -200,6 +212,7 @@ describe("SchemaConverterNode", () => { context: mockContext, accessPath: [], pathId: "test", + seenSchemas: new Set(), }); expect(node.convert()).toBeUndefined(); }); diff --git a/packages/parsers/src/openapi/BaseOpenApiV3_1Converter.node.ts b/packages/parsers/src/openapi/BaseOpenApiV3_1Converter.node.ts index 9099fac73b..2e30dcd1c0 100644 --- a/packages/parsers/src/openapi/BaseOpenApiV3_1Converter.node.ts +++ b/packages/parsers/src/openapi/BaseOpenApiV3_1Converter.node.ts @@ -66,3 +66,22 @@ export abstract class BaseOpenApiV3_1ConverterNodeWithExample< > extends BaseOpenApiV3_1ConverterNode { abstract example(): unknown | undefined; } + +export type BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs = + BaseOpenApiV3_1ConverterNodeConstructorArgs & { + seenSchemas: Set; + }; + +export abstract class BaseOpenApiV3_1ConverterNodeWithTracking< + Input, + Output, +> extends BaseOpenApiV3_1ConverterNodeWithExample { + protected readonly seenSchemas: Set; + + constructor( + args: BaseOpenApiV3_1ConverterNodeWithTrackingConstructorArgs + ) { + super(args); + this.seenSchemas = new Set(args.seenSchemas); + } +} diff --git a/packages/parsers/src/openapi/__test__/OpenApiDocumentConverterNode.test.ts b/packages/parsers/src/openapi/__test__/OpenApiDocumentConverterNode.test.ts index 5b6996ee79..7818e7bbd2 100644 --- a/packages/parsers/src/openapi/__test__/OpenApiDocumentConverterNode.test.ts +++ b/packages/parsers/src/openapi/__test__/OpenApiDocumentConverterNode.test.ts @@ -7,8 +7,8 @@ import { ErrorCollector } from "../../ErrorCollector"; import { OpenApiDocumentConverterNode } from "../3.1/OpenApiDocumentConverter.node"; import { BaseOpenApiV3_1ConverterNodeContext } from "../BaseOpenApiV3_1Converter.node"; -function replaceEndpointUUIDs(json: string): string { - return json.replace( +function replaceEndpointUUIDs(json: string): string | undefined { + return json?.replace( /"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"/g, '"test-uuid-replacement"' ); @@ -43,7 +43,7 @@ describe("OpenAPI snapshot tests", () => { const errors = []; const warnings = []; - expect(parsed.components?.schemas).toBeDefined(); + // expect(parsed.components?.schemas).toBeDefined(); if (parsed.components?.schemas) { const converter = new OpenApiDocumentConverterNode({ @@ -66,7 +66,9 @@ describe("OpenAPI snapshot tests", () => { // console.warn("warnings:", warnings); } - converted.id = "test-uuid-replacement"; + if (converted) { + converted.id = "test-uuid-replacement"; + } await expect( replaceEndpointUUIDs(JSON.stringify(converted, null, 2)) ).toMatchFileSnapshot(`./__snapshots__/${directory}.json`); diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/anyOf.json b/packages/parsers/src/openapi/__test__/__snapshots__/anyOf.json new file mode 100644 index 0000000000..f68c657390 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/anyOf.json @@ -0,0 +1,111 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.Get": { + "id": "endpoint_.Get", + "operationId": "Get", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "get" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Response" + } + }, + "description": "A simple API response." + } + ], + "errors": [], + "examples": [ + { + "path": "/get", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "value": 0 + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "Request": { + "name": "Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An optional string value.\n" + } + ] + }, + "description": "A generic request type used throughout the API.\n" + }, + "Response": { + "name": "Response", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "An optional numerical value.\n" + } + ] + }, + "description": "A generic response type used throughout the API.\n" + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/application-json.json b/packages/parsers/src/openapi/__test__/__snapshots__/application-json.json new file mode 100644 index 0000000000..0aa4ab844c --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/application-json.json @@ -0,0 +1,128 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.vndFernUserJsonVersion1": { + "id": "endpoint_.vndFernUserJsonVersion1", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "vnd.fern.user+json;version=1" + } + ], + "environments": [], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Data" + } + }, + "description": "Success" + } + ], + "errors": [], + "examples": [ + { + "path": "/vnd.fern.user+json;version=1", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "foo": "string", + "bar": "string" + } + } + } + ] + }, + "endpoint_.applicationJson": { + "id": "endpoint_.applicationJson", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "application-json" + } + ], + "environments": [], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Data" + } + }, + "description": "Success" + } + ], + "errors": [], + "examples": [ + { + "path": "/application-json", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "foo": "string", + "bar": "string" + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "Data": { + "name": "Data", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "foo", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "bar", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/availability.json b/packages/parsers/src/openapi/__test__/__snapshots__/availability.json new file mode 100644 index 0000000000..b5949f9a40 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/availability.json @@ -0,0 +1,654 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.xFernAvailabilityPathParam": { + "id": "endpoint_.xFernAvailabilityPathParam", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "collection" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "active_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "deprecated_ref_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "x-fern-availability_path_param" + } + ], + "environments": [], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "collection id" + }, + { + "key": "active_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "active header" + }, + { + "key": "deprecated_ref_id", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "DeprecatedParam" + } + }, + "availability": "Deprecated" + }, + { + "key": "x-fern-availability_path_param", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "active beta header" + } + ], + "queryParameters": [ + { + "key": "deprecated_lang", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "language code" + }, + { + "key": "active_lang", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "language code" + }, + { + "key": "deprecated_ref_lang", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "DeprecatedParam" + } + } + } + }, + "availability": "Deprecated" + }, + { + "key": "x-fern-availability_query_param", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "active beta query param" + } + ], + "requestHeaders": [ + { + "key": "X-Deprecated-Header", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "deprecated header" + }, + { + "key": "X-Active-Header", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "active header" + }, + { + "key": "X-Deprecated-Ref-Header", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "DeprecatedParam" + } + } + } + }, + "availability": "Deprecated" + }, + { + "key": "x-fern-availability_header", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "active beta header" + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "WholeDeprecatedSettings" + } + }, + "description": "OK" + } + ], + "errors": [], + "examples": [ + { + "path": "/collection/{id}/{active_id}/{deprecated_ref_id}/{x-fern-availability_path_param}", + "responseStatusCode": 200, + "pathParameters": { + "id": "string", + "active_id": "string", + "deprecated_ref_id": "string", + "x-fern-availability_path_param": "string" + }, + "queryParameters": { + "deprecated_lang": "string", + "active_lang": "string", + "deprecated_ref_lang": "string", + "x-fern-availability_query_param": "string" + }, + "headers": { + "X-Deprecated-Header": "string", + "X-Active-Header": "string", + "X-Deprecated-Ref-Header": "string", + "x-fern-availability_header": "string" + }, + "responseBody": { + "type": "json", + "value": { + "fine_setting": false + } + } + } + ] + }, + "endpoint_.successRef": { + "id": "endpoint_.successRef", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "success-ref" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Settings" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "NotDeprecatedSettings" + } + }, + "description": "OK" + } + ], + "errors": [], + "examples": [ + { + "path": "/success-ref", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "not_deprecated_setting": false + } + } + } + ] + }, + "endpoint_.successInlinePropertyDeprecation": { + "id": "endpoint_.successInlinePropertyDeprecation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "success-inline-property-deprecation" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "deprecated_setting", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "availability": "Deprecated" + }, + { + "key": "new_setting", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "NotDeprecatedSettings" + } + }, + "description": "OK" + } + ], + "errors": [], + "examples": [ + { + "path": "/success-inline-property-deprecation", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "not_deprecated_setting": false + } + } + } + ] + }, + "endpoint_.successInlineObjectDeprecation": { + "id": "endpoint_.successInlineObjectDeprecation", + "availability": "Deprecated", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "success-inline-object-deprecation" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fine_setting", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "NotDeprecatedSettings" + } + }, + "description": "OK" + } + ], + "errors": [], + "examples": [ + { + "path": "/success-inline-object-deprecation", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "not_deprecated_setting": false + } + } + } + ] + }, + "endpoint_.successInlineBetaBody": { + "id": "endpoint_.successInlineBetaBody", + "availability": "Beta", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "success-inline-beta-body" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fine_setting", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "NotDeprecatedSettings" + } + }, + "description": "OK" + } + ], + "errors": [], + "examples": [ + { + "path": "/success-inline-beta-body", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "not_deprecated_setting": false + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "DeprecatedParam": { + "name": "DeprecatedParam", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "Settings": { + "name": "Settings", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "deprecated_setting", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "availability": "Deprecated" + }, + { + "key": "new_setting", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "WholeDeprecatedSettings": { + "name": "WholeDeprecatedSettings", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "fine_setting", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "NotDeprecatedSettings": { + "name": "NotDeprecatedSettings", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "not_deprecated_setting", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/cohere.json b/packages/parsers/src/openapi/__test__/__snapshots__/cohere.json index b3908992a5..781b59a20b 100644 --- a/packages/parsers/src/openapi/__test__/__snapshots__/cohere.json +++ b/packages/parsers/src/openapi/__test__/__snapshots__/cohere.json @@ -28408,7 +28408,8 @@ "type": "alias", "value": { "type": "id", - "id": "Status" + "id": "Status", + "default": "STATUS_UNSPECIFIED" } } } @@ -37832,7 +37833,8 @@ "type": "alias", "value": { "type": "id", - "id": "AuthTokenType" + "id": "AuthTokenType", + "default": "noscheme" } } }, @@ -39455,7 +39457,8 @@ "type": "alias", "value": { "type": "id", - "id": "BaseType" + "id": "BaseType", + "default": "BASE_TYPE_UNSPECIFIED" } }, "description": "The type of the base model." @@ -39470,7 +39473,8 @@ "type": "alias", "value": { "type": "id", - "id": "Strategy" + "id": "Strategy", + "default": "STRATEGY_UNSPECIFIED" } } } @@ -39606,7 +39610,8 @@ "type": "alias", "value": { "type": "id", - "id": "LoraTargetModules" + "id": "LoraTargetModules", + "default": "LORA_TARGET_MODULES_UNSPECIFIED" } }, "description": "The combination of LoRA modules to target." @@ -39891,7 +39896,8 @@ "type": "alias", "value": { "type": "id", - "id": "Status" + "id": "Status", + "default": "STATUS_UNSPECIFIED" } } } @@ -40151,7 +40157,8 @@ "type": "alias", "value": { "type": "id", - "id": "Status" + "id": "Status", + "default": "STATUS_UNSPECIFIED" } }, "description": "Status of the fine-tuned model." diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/content-type.json b/packages/parsers/src/openapi/__test__/__snapshots__/content-type.json new file mode 100644 index 0000000000..66dc9051da --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/content-type.json @@ -0,0 +1 @@ +undefined \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/default-content.json b/packages/parsers/src/openapi/__test__/__snapshots__/default-content.json new file mode 100644 index 0000000000..9c1e97b19e --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/default-content.json @@ -0,0 +1,106 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_generativelanguage.GenerateContent": { + "id": "endpoint_generativelanguage.GenerateContent", + "namespace": [ + "generativelanguage" + ], + "operationId": "GenerateContent", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "generateContent" + } + ], + "defaultEnvironment": "https://ai.com", + "environments": [ + { + "id": "https://ai.com", + "baseUrl": "https://ai.com" + } + ], + "pathParameters": [ + { + "key": "model", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "responses": [ + { + "statusCode": null, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "GenerateContentResponse" + } + }, + "description": "Successful operation" + } + ], + "errors": [], + "examples": [ + { + "path": "/generateContent", + "responseStatusCode": null, + "pathParameters": { + "model": "string" + }, + "responseBody": { + "type": "json", + "value": { + "bar": "string" + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "GenerateContentResponse": { + "name": "GenerateContentResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "bar", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + } + }, + "subpackages": { + "generativelanguage": { + "id": "generativelanguage", + "name": "generativelanguage", + "displayName": "generativelanguage" + } + }, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/defaults.json b/packages/parsers/src/openapi/__test__/__snapshots__/defaults.json new file mode 100644 index 0000000000..66dc9051da --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/defaults.json @@ -0,0 +1 @@ +undefined \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/discriminated-union-value-title.json b/packages/parsers/src/openapi/__test__/__snapshots__/discriminated-union-value-title.json new file mode 100644 index 0000000000..272d081145 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/discriminated-union-value-title.json @@ -0,0 +1,214 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.Get": { + "id": "endpoint_.Get", + "operationId": "Get", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "get" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Response" + } + }, + "description": "A simple API response." + } + ], + "errors": [], + "examples": [ + { + "path": "/get", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "value": 0 + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "Request": { + "name": "A simple request title", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An optional string value.\n" + } + ] + }, + "description": "A generic request type used throughout the API.\n" + }, + "Response": { + "name": "A simple response title", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "An optional numerical value.\n" + } + ] + }, + "description": "A generic response type used throughout the API.\n" + }, + "SampleUnion": { + "name": "SampleUnion", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "request", + "displayName": "A simple request title", + "description": "A generic request type used throughout the API.\n", + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An optional string value.\n" + } + ] + }, + { + "discriminantValue": "request", + "displayName": "A simple request title", + "description": "A generic request type used throughout the API.\n", + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + }, + "description": "An optional string value.\n" + } + ] + }, + { + "discriminantValue": "response", + "displayName": "A simple response title", + "description": "A generic response type used throughout the API.\n", + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "An optional numerical value.\n" + } + ] + }, + { + "discriminantValue": "response", + "displayName": "A simple response title", + "description": "A generic response type used throughout the API.\n", + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "unknown" + } + } + } + }, + "description": "An optional numerical value.\n" + } + ] + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/enum-casing.json b/packages/parsers/src/openapi/__test__/__snapshots__/enum-casing.json new file mode 100644 index 0000000000..2062426576 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/enum-casing.json @@ -0,0 +1,131 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.example": { + "id": "endpoint_.example", + "displayName": "Get Example", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "example" + } + ], + "environments": [], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ExampleResponse" + } + }, + "description": "Successful response" + } + ], + "errors": [], + "examples": [ + { + "path": "/example", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "status": "success", + "message": "string", + "custom_fields": {} + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "ExampleResponse": { + "name": "ExampleResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "status", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "success" + }, + { + "value": "failure" + } + ] + } + }, + { + "key": "message", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "custom_fields", + "valueShape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + "GrantTypeEnum": { + "name": "GrantTypeEnum", + "shape": { + "type": "enum", + "values": [ + { + "value": "urn:devrev:params:oauth:grant-type:token-issue" + }, + { + "value": "urn:ietf:params:oauth:grant-type:token-exchange" + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/example-depth.json b/packages/parsers/src/openapi/__test__/__snapshots__/example-depth.json new file mode 100644 index 0000000000..72bcbc43db --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/example-depth.json @@ -0,0 +1,87 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.getTree": { + "id": "endpoint_.getTree", + "displayName": "Get tree", + "operationId": "getTree", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tree" + } + ], + "environments": [], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "TreeNode" + } + }, + "description": "Successfully retrieved tree" + } + ], + "errors": [], + "examples": [] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "TreeNode": { + "name": "TreeNode", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The value stored in this node" + }, + { + "key": "left", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "TreeNode" + } + }, + "description": "Child nodes of this tree node" + }, + { + "key": "right", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "TreeNode" + } + }, + "description": "Child nodes of this tree node" + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/file-upload.json b/packages/parsers/src/openapi/__test__/__snapshots__/file-upload.json new file mode 100644 index 0000000000..66dc9051da --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/file-upload.json @@ -0,0 +1 @@ +undefined \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/float.json b/packages/parsers/src/openapi/__test__/__snapshots__/float.json new file mode 100644 index 0000000000..07d06ef2e2 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/float.json @@ -0,0 +1,122 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.Get": { + "id": "endpoint_.Get", + "operationId": "Get", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "get" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Response" + } + }, + "description": "A simple API response." + } + ], + "errors": [], + "examples": [ + { + "path": "/get", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "id": 0, + "value": 0 + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "Request": { + "name": "Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + }, + "description": "A generic request type used throughout the API.\n" + }, + "Response": { + "name": "Response", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + }, + "description": "A generic response type used throughout the API.\n" + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/inline-path-parameters.json b/packages/parsers/src/openapi/__test__/__snapshots__/inline-path-parameters.json new file mode 100644 index 0000000000..66dc9051da --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/inline-path-parameters.json @@ -0,0 +1 @@ +undefined \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/inline-schema-reference.json b/packages/parsers/src/openapi/__test__/__snapshots__/inline-schema-reference.json new file mode 100644 index 0000000000..9e55709223 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/inline-schema-reference.json @@ -0,0 +1,96 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.example": { + "id": "endpoint_.example", + "displayName": "Get Example", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "example" + } + ], + "environments": [], + "responses": [], + "errors": [], + "examples": [] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "Schema1": { + "name": "Schema1", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "Schema2": { + "name": "Schema2", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "age", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/json-string.json b/packages/parsers/src/openapi/__test__/__snapshots__/json-string.json new file mode 100644 index 0000000000..8cf0912a0f --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/json-string.json @@ -0,0 +1,43 @@ +{ + "id": "test-uuid-replacement", + "endpoints": {}, + "websockets": {}, + "webhooks": {}, + "types": { + "User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + }, + { + "key": "metadata", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/multi-url-generators-yml.json b/packages/parsers/src/openapi/__test__/__snapshots__/multi-url-generators-yml.json new file mode 100644 index 0000000000..94f79ae5b1 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/multi-url-generators-yml.json @@ -0,0 +1,293 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.users": { + "id": "endpoint_.users", + "description": "List information about all users", + "displayName": "List Users", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "users" + } + ], + "defaultEnvironment": "https://a.com", + "environments": [ + { + "id": "https://a.com", + "baseUrl": "https://a.com" + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "User" + } + }, + "description": "Successful response" + } + ], + "errors": [], + "examples": [ + { + "path": "/users", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "id": "string", + "username": "string", + "email": "string", + "createdAt": "string" + } + } + } + ] + }, + "endpoint_.userId": { + "id": "endpoint_.userId", + "description": "Retrieve detailed information about a specific user", + "displayName": "Get user information", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "users" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "userId" + } + ], + "defaultEnvironment": "https://a.com", + "environments": [ + { + "id": "https://a.com", + "baseUrl": "https://a.com" + } + ], + "pathParameters": [ + { + "key": "userId", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "User" + } + }, + "description": "Successful response" + } + ], + "errors": [], + "examples": [ + { + "path": "/users/{userId}", + "responseStatusCode": 200, + "pathParameters": { + "userId": "string" + }, + "responseBody": { + "type": "json", + "value": { + "id": "string", + "username": "string", + "email": "string", + "createdAt": "string" + } + } + } + ] + }, + "endpoint_.token": { + "id": "endpoint_.token", + "description": "Retrieve an authentication token for the API", + "displayName": "Get authentication token", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "token" + } + ], + "defaultEnvironment": "https://a.com", + "environments": [ + { + "id": "https://a.com", + "baseUrl": "https://a.com" + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Token" + } + }, + "description": "Successful response" + } + ], + "errors": [], + "examples": [ + { + "path": "/token", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "accessToken": "string", + "tokenType": "string", + "expiresIn": 0 + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "username", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "createdAt", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "Token": { + "name": "Token", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "accessToken", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "tokenType", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "expiresIn", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/non-alphanumeric-characters.json b/packages/parsers/src/openapi/__test__/__snapshots__/non-alphanumeric-characters.json new file mode 100644 index 0000000000..24a320c0e3 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/non-alphanumeric-characters.json @@ -0,0 +1,106 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.settings": { + "id": "endpoint_.settings", + "method": "PATCH", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "settings" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Settings" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Settings" + } + }, + "description": "OK" + } + ], + "errors": [], + "examples": [ + { + "path": "/settings", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "separator": "/" + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "Settings": { + "name": "Settings", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "separator", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "DocumentIDSeparators" + } + } + } + ] + } + }, + "DocumentIDSeparators": { + "name": "DocumentIDSeparators", + "shape": { + "type": "enum", + "values": [ + { + "value": "/" + }, + { + "value": "-" + }, + { + "value": "|" + }, + { + "value": "." + }, + { + "value": "" + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/nullable.json b/packages/parsers/src/openapi/__test__/__snapshots__/nullable.json new file mode 100644 index 0000000000..3327dc182a --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/nullable.json @@ -0,0 +1,512 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.users": { + "id": "endpoint_.users", + "displayName": "Update a user", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "users" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "UserUpdate" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "User" + } + }, + "description": "User updated successfully" + } + ], + "errors": [], + "examples": [ + { + "path": "/users", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "id": "string", + "name": "string", + "email": "string", + "createdAt": "string", + "settings": { + "theme": "string", + "notifications": false, + "lastModified": "string" + }, + "stats": { + "totalLogins": 0, + "lastLoginTime": "string", + "accountStatus": "active" + } + } + } + } + ] + }, + "endpoint_.userId": { + "id": "endpoint_.userId", + "displayName": "Get a user", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "users" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "userId" + } + ], + "environments": [], + "pathParameters": [ + { + "key": "userId", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "queryParameters": [ + { + "key": "activated", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "User" + } + }, + "description": "User retrieved successfully" + } + ], + "errors": [], + "examples": [ + { + "path": "/users/{userId}", + "responseStatusCode": 200, + "pathParameters": { + "userId": "string" + }, + "queryParameters": { + "activated": "string", + "email": "string" + }, + "responseBody": { + "type": "json", + "value": { + "id": "string", + "name": "string", + "email": "string", + "createdAt": "string", + "settings": { + "theme": "string", + "notifications": false, + "lastModified": "string" + }, + "stats": { + "totalLogins": 0, + "lastLoginTime": "string", + "accountStatus": "active" + } + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "UserCreate": { + "name": "UserCreate", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "settings", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "UserSettings" + } + } + } + } + } + ] + } + }, + "UserUpdate": { + "name": "UserUpdate", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + }, + { + "key": "settings", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "UserSettings" + } + } + } + } + } + ] + } + }, + "User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "createdAt", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + } + }, + { + "key": "settings", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "UserSettings" + } + } + } + } + }, + { + "key": "stats", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "UserStats" + } + } + } + } + } + ] + } + }, + "UserSettings": { + "name": "UserSettings", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "theme", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "notifications", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "lastModified", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + } + } + ] + } + }, + "UserStats": { + "name": "UserStats", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "totalLogins", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + } + }, + { + "key": "lastLoginTime", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + } + }, + { + "key": "accountStatus", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [ + { + "value": "active" + }, + { + "value": "suspended" + }, + { + "value": "deleted" + } + ] + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/oauth.json b/packages/parsers/src/openapi/__test__/__snapshots__/oauth.json new file mode 100644 index 0000000000..66dc9051da --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/oauth.json @@ -0,0 +1 @@ +undefined \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/only-include-referenced-schemas.json b/packages/parsers/src/openapi/__test__/__snapshots__/only-include-referenced-schemas.json new file mode 100644 index 0000000000..e325d48cad --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/only-include-referenced-schemas.json @@ -0,0 +1,42377 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_admins.identifyAdmin": { + "id": "endpoint_admins.identifyAdmin", + "description": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", + "namespace": [ + "Admins" + ], + "displayName": "Identify an admin", + "operationId": "identifyAdmin", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "me" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "admin_with_app" + } + }, + "description": "Successful response" + } + ], + "errors": [], + "examples": [ + { + "path": "/me", + "responseStatusCode": 200, + "name": "Successful response", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "admin", + "id": "991267390", + "email": "admin1@email.com", + "name": "Ciaran1 Lee", + "email_verified": true, + "app": { + "type": "app", + "id_code": "this_is_an_id1_that_should_be_at_least_40", + "name": "MyApp 1", + "created_at": 1719492696, + "secure": false, + "identity_verification": false, + "timezone": "America/Los_Angeles", + "region": "US" + }, + "avatar": { + "type": "avatar", + "image_url": "https://static.intercomassets.com/assets/default-avatars/admins/128.png" + }, + "has_inbox_seat": true + } + } + } + ] + }, + "endpoint_admins.setAwayAdmin": { + "id": "endpoint_admins.setAwayAdmin", + "description": "You can set an Admin as away for the Inbox.", + "namespace": [ + "Admins" + ], + "displayName": "Set an admin to away", + "operationId": "setAwayAdmin", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "admins" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "away" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier of a given admin" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "away_mode_enabled", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + }, + "description": "Set to \"true\" to change the status of the admin to away." + }, + { + "key": "away_mode_reassign", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Set to \"true\" to assign any new conversation replies to your default inbox." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "admin" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Admin not found", + "name": "Not Found", + "examples": [ + { + "name": "Admin not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "admin_not_found", + "message": "Admin for admin_id not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/admins/{id}/away", + "responseStatusCode": 200, + "name": "Successful response", + "pathParameters": { + "id": 0 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "admin", + "id": "991267391", + "name": "Ciaran2 Lee", + "email": "admin2@email.com", + "away_mode_enabled": true, + "away_mode_reassign": true, + "has_inbox_seat": true, + "team_ids": [] + } + } + }, + { + "path": "/admins/{id}/away", + "responseStatusCode": 200, + "pathParameters": { + "id": 0 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "away_mode_enabled": true, + "away_mode_reassign": true + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/admins/{id}/away", + "responseStatusCode": 200, + "pathParameters": { + "id": 0 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "away_mode_enabled": true, + "away_mode_reassign": true + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/admins/{id}/away", + "responseStatusCode": 200, + "pathParameters": { + "id": 0 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "away_mode_enabled": true, + "away_mode_reassign": true + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_admins.listActivityLogs": { + "id": "endpoint_admins.listActivityLogs", + "description": "You can get a log of activities by all admins in an app.", + "namespace": [ + "Admins" + ], + "displayName": "List all activity logs", + "operationId": "listActivityLogs", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "admins" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "activity_logs" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "created_at_after", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The start date that you request data for. It must be formatted as a UNIX timestamp." + }, + { + "key": "created_at_before", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The end date that you request data for. It must be formatted as a UNIX timestamp." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "activity_log_list" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/admins/activity_logs", + "responseStatusCode": 200, + "name": "Successful response", + "queryParameters": { + "created_at_after": "1677253093", + "created_at_before": "1677861493" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "activity_log.list", + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 20, + "total_pages": 1 + }, + "activity_logs": [ + { + "id": "test-uuid-replacement", + "performed_by": { + "type": "admin", + "id": "991267395", + "email": "admin5@email.com", + "ip": "127.0.0.1" + }, + "metadata": { + "message": { + "id": 123, + "title": "Initial message title" + }, + "before": "Initial message title", + "after": "Eventual message title" + }, + "created_at": 1719492702, + "activity_type": "message_state_change", + "activity_description": "Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title." + }, + { + "id": "test-uuid-replacement", + "performed_by": { + "type": "admin", + "id": "991267395", + "email": "admin5@email.com", + "ip": "127.0.0.1" + }, + "metadata": { + "before": "before", + "after": "after" + }, + "created_at": 1719492702, + "activity_type": "app_name_change", + "activity_description": "Ciaran5 Lee changed your app name from before to after." + } + ] + } + } + } + ] + }, + "endpoint_admins.listAdmins": { + "id": "endpoint_admins.listAdmins", + "description": "You can fetch a list of admins for a given workspace.", + "namespace": [ + "Admins" + ], + "displayName": "List all admins", + "operationId": "listAdmins", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "admins" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "admin_list" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/admins", + "responseStatusCode": 200, + "name": "Successful response", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "admin.list", + "admins": [ + { + "type": "admin", + "email": "admin7@email.com", + "id": "991267397", + "name": "Ciaran7 Lee", + "away_mode_enabled": false, + "away_mode_reassign": false, + "has_inbox_seat": true, + "team_ids": [] + } + ] + } + } + } + ] + }, + "endpoint_admins.retrieveAdmin": { + "id": "endpoint_admins.retrieveAdmin", + "description": "You can retrieve the details of a single admin.", + "namespace": [ + "Admins" + ], + "displayName": "Retrieve an admin", + "operationId": "retrieveAdmin", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "admins" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier of a given admin" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "admin" + } + }, + "description": "Admin found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Admin not found", + "name": "Not Found", + "examples": [ + { + "name": "Admin not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "admin_not_found", + "message": "Admin not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/admins/{id}", + "responseStatusCode": 200, + "name": "Admin found", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "admin", + "id": "991267399", + "name": "Ciaran9 Lee", + "email": "admin9@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false, + "has_inbox_seat": true, + "team_ids": [] + } + } + } + ] + }, + "endpoint_articles.listArticles": { + "id": "endpoint_articles.listArticles", + "description": "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.\n\n> 📘 How are the articles sorted and ordered?\n>\n> 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.\n", + "namespace": [ + "Articles" + ], + "displayName": "List all articles", + "operationId": "listArticles", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "article_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 25, + "total_pages": 1 + }, + "total_count": 1, + "data": [ + { + "id": "39", + "type": "article", + "workspace_id": "this_is_an_id33_that_should_be_at_least_4", + "parent_id": 143, + "parent_type": "collection", + "parent_ids": [], + "title": "This is the article title", + "description": "", + "body": "", + "author_id": 991267402, + "state": "published", + "created_at": 1719492707, + "updated_at": 1719492707, + "url": "http://help-center.test/myapp-33/en/articles/39-this-is-the-article-title" + } + ] + } + } + } + ] + }, + "endpoint_articles.createArticle": { + "id": "endpoint_articles.createArticle", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "namespace": [ + "Articles" + ], + "displayName": "Create an article", + "operationId": "createArticle", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_article_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "article" + } + }, + "description": "article created" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Bad Request", + "name": "Bad Request", + "examples": [ + { + "name": "Bad Request", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_not_found", + "message": "author_id must be in the main body or default locale translated_content object" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles", + "responseStatusCode": 200, + "name": "article created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "42", + "type": "article", + "workspace_id": "this_is_an_id37_that_should_be_at_least_4", + "parent_id": 145, + "parent_type": "collection", + "parent_ids": [], + "statistics": { + "type": "article_statistics", + "views": 0, + "conversations": 0, + "reactions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "sad_reaction_percentage": 0 + }, + "title": "Thanks for everything", + "description": "Description of the Article", + "body": "

Body of the Article

", + "author_id": 991267407, + "state": "published", + "created_at": 1719492710, + "updated_at": 1719492710, + "url": "http://help-center.test/myapp-37/en/articles/42-thanks-for-everything" + } + } + }, + { + "path": "/articles", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/articles", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_articles.retrieveArticle": { + "id": "endpoint_articles.retrieveArticle", + "description": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`.", + "namespace": [ + "Articles" + ], + "displayName": "Retrieve an article", + "operationId": "retrieveArticle", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the article which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "article" + } + }, + "description": "Article found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Article not found", + "name": "Not Found", + "examples": [ + { + "name": "Article not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "name": "Article found", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "45", + "type": "article", + "workspace_id": "this_is_an_id43_that_should_be_at_least_4", + "parent_id": 148, + "parent_type": "collection", + "parent_ids": [], + "statistics": { + "type": "article_statistics", + "views": 0, + "conversations": 0, + "reactions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "sad_reaction_percentage": 0 + }, + "title": "This is the article title", + "description": "", + "body": "", + "author_id": 991267412, + "state": "published", + "created_at": 1719492712, + "updated_at": 1719492712, + "url": "http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title" + } + } + } + ] + }, + "endpoint_articles.updateArticle": { + "id": "endpoint_articles.updateArticle", + "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", + "namespace": [ + "Articles" + ], + "displayName": "Update an article", + "operationId": "updateArticle", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the article which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_article_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "article" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Article Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Article Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "48", + "type": "article", + "workspace_id": "this_is_an_id49_that_should_be_at_least_4", + "parent_id": 151, + "parent_type": "collection", + "parent_ids": [], + "statistics": { + "type": "article_statistics", + "views": 0, + "conversations": 0, + "reactions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "sad_reaction_percentage": 0 + }, + "title": "Christmas is here!", + "description": "", + "body": "

New gifts in store for the jolly season

", + "author_id": 991267418, + "state": "published", + "created_at": 1719492714, + "updated_at": 1719492714, + "url": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here" + } + } + }, + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "48", + "type": "article", + "workspace_id": "this_is_an_id49_that_should_be_at_least_4", + "parent_id": 151, + "parent_type": "collection", + "parent_ids": [], + "statistics": { + "type": "article_statistics", + "views": 0, + "conversations": 0, + "reactions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "sad_reaction_percentage": 0 + }, + "title": "Christmas is here!", + "description": "", + "body": "

New gifts in store for the jolly season

", + "author_id": 991267418, + "state": "published", + "created_at": 1719492714, + "updated_at": 1719492714, + "url": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here" + } + } + }, + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_articles.deleteArticle": { + "id": "endpoint_articles.deleteArticle", + "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", + "namespace": [ + "Articles" + ], + "displayName": "Delete an article", + "operationId": "deleteArticle", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the article which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "deleted_article_object" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Article Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Article Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "51", + "object": "article", + "deleted": true + } + } + } + ] + }, + "endpoint_articles.searchArticles": { + "id": "endpoint_articles.searchArticles", + "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", + "namespace": [ + "Articles" + ], + "displayName": "Search for articles", + "operationId": "searchArticles", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "search" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "phrase", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The phrase within your articles to search for." + }, + { + "key": "state", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The state of the Articles returned. One of `published`, `draft` or `all`." + }, + { + "key": "help_center_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The ID of the Help Center to search in." + }, + { + "key": "highlight", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Return a highlighted version of the matching content within your articles. Refer to the response schema for more details." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "article_search_response" + } + }, + "description": "Search successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles/search", + "responseStatusCode": 200, + "name": "Search successful", + "queryParameters": { + "phrase": "Getting started", + "state": "published", + "help_center_id": 123, + "highlight": false + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "total_count": 1, + "data": { + "articles": [ + { + "id": "55", + "type": "article", + "workspace_id": "this_is_an_id61_that_should_be_at_least_4", + "parent_id": null, + "parent_type": null, + "parent_ids": [], + "title": "Title 1", + "description": "", + "body": "", + "author_id": 991267431, + "state": "draft", + "created_at": 1719492719, + "updated_at": 1719492719, + "url": null + } + ], + "highlights": [] + }, + "pages": { + "type": "pages", + "page": 1, + "total_pages": 1, + "per_page": 10 + } + } + } + } + ] + }, + "endpoint_helpCenter.listAllCollections": { + "id": "endpoint_helpCenter.listAllCollections", + "description": "You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`.\n\nCollections 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 collections first.\n", + "namespace": [ + "Help Center" + ], + "displayName": "List all collections", + "operationId": "listAllCollections", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "collections" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "collection_list" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/collections", + "responseStatusCode": 200, + "name": "Successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "id": "159", + "workspace_id": "this_is_an_id65_that_should_be_at_least_4", + "name": "English collection title", + "url": "http://help-center.test/myapp-65/collection-17", + "order": 17, + "created_at": 1719492720, + "updated_at": 1719492720, + "description": "english collection description", + "icon": "bookmark", + "parent_id": null, + "help_center_id": 79 + }, + { + "id": "160", + "workspace_id": "this_is_an_id65_that_should_be_at_least_4", + "name": "English section title", + "url": "http://help-center.test/myapp-65/section-1", + "order": 1, + "created_at": 1719492720, + "updated_at": 1719492720, + "description": null, + "icon": "bookmark", + "parent_id": "159", + "help_center_id": null + } + ], + "total_count": 2, + "pages": { + "type": "pages", + "page": 1, + "per_page": 20, + "total_pages": 1 + } + } + } + } + ] + }, + "endpoint_helpCenter.createCollection": { + "id": "endpoint_helpCenter.createCollection", + "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", + "namespace": [ + "Help Center" + ], + "displayName": "Create a collection", + "operationId": "createCollection", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "collections" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_collection_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "collection" + } + }, + "description": "collection created" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Bad Request", + "name": "Bad Request", + "examples": [ + { + "name": "Bad Request", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_not_found", + "message": "Name is a required parameter." + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/collections", + "responseStatusCode": 200, + "name": "collection created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "165", + "workspace_id": "this_is_an_id69_that_should_be_at_least_4", + "name": "Thanks for everything", + "url": "http://help-center.test/myapp-69/", + "order": 1, + "created_at": 1719492721, + "updated_at": 1719492721, + "description": "", + "icon": "book-bookmark", + "parent_id": null, + "help_center_id": 81 + } + } + }, + { + "path": "/help_center/collections", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/help_center/collections", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_helpCenter.retrieveCollection": { + "id": "endpoint_helpCenter.retrieveCollection", + "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", + "namespace": [ + "Help Center" + ], + "displayName": "Retrieve a collection", + "operationId": "retrieveCollection", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "collections" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the collection which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "collection" + } + }, + "description": "Collection found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Collection not found", + "name": "Not Found", + "examples": [ + { + "name": "Collection not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "name": "Collection found", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "170", + "workspace_id": "this_is_an_id75_that_should_be_at_least_4", + "name": "English collection title", + "url": "http://help-center.test/myapp-75/collection-22", + "order": 22, + "created_at": 1719492723, + "updated_at": 1719492723, + "description": "english collection description", + "icon": "bookmark", + "parent_id": null, + "help_center_id": 84 + } + } + } + ] + }, + "endpoint_helpCenter.updateCollection": { + "id": "endpoint_helpCenter.updateCollection", + "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", + "namespace": [ + "Help Center" + ], + "displayName": "Update a collection", + "operationId": "updateCollection", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "collections" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the collection which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_collection_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "collection" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Collection Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Collection Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "176", + "workspace_id": "this_is_an_id81_that_should_be_at_least_4", + "name": "Update collection name", + "url": "http://help-center.test/myapp-81/collection-25", + "order": 25, + "created_at": 1719492724, + "updated_at": 1719492724, + "description": "english collection description", + "icon": "folder", + "parent_id": null, + "help_center_id": 87 + } + } + }, + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "176", + "workspace_id": "this_is_an_id81_that_should_be_at_least_4", + "name": "Update collection name", + "url": "http://help-center.test/myapp-81/collection-25", + "order": 25, + "created_at": 1719492724, + "updated_at": 1719492724, + "description": "english collection description", + "icon": "folder", + "parent_id": null, + "help_center_id": 87 + } + } + }, + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_helpCenter.deleteCollection": { + "id": "endpoint_helpCenter.deleteCollection", + "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "namespace": [ + "Help Center" + ], + "displayName": "Delete a collection", + "operationId": "deleteCollection", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "collections" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the collection which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "deleted_collection_object" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "collection Not Found", + "name": "Not Found", + "examples": [ + { + "name": "collection Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "182", + "object": "collection", + "deleted": true + } + } + } + ] + }, + "endpoint_helpCenter.retrieveHelpCenter": { + "id": "endpoint_helpCenter.retrieveHelpCenter", + "description": "You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/`.", + "namespace": [ + "Help Center" + ], + "displayName": "Retrieve a Help Center", + "operationId": "retrieveHelpCenter", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_centers" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the collection which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "help_center" + } + }, + "description": "Collection found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Collection not found", + "name": "Not Found", + "examples": [ + { + "name": "Collection not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/help_centers/{id}", + "responseStatusCode": 200, + "name": "Collection found", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "93", + "workspace_id": "this_is_an_id93_that_should_be_at_least_4", + "created_at": 1719492727, + "updated_at": 1719492727, + "identifier": "help-center-1", + "website_turned_on": false, + "display_name": "Intercom Help Center" + } + } + } + ] + }, + "endpoint_helpCenter.listHelpCenters": { + "id": "endpoint_helpCenter.listHelpCenters", + "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", + "namespace": [ + "Help Center" + ], + "displayName": "List all Help Centers", + "operationId": "listHelpCenters", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_centers" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "help_center_list" + } + }, + "description": "Help Centers found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/help_centers", + "responseStatusCode": 200, + "name": "Help Centers found", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [] + } + } + } + ] + }, + "endpoint_companies.retrieveCompany": { + "id": "endpoint_companies.retrieveCompany", + "description": "You can fetch a single company by passing in `company_id` or `name`.\n\n `https://api.intercom.io/companies?name={name}`\n\n `https://api.intercom.io/companies?company_id={company_id}`\n\nYou can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter.\n\n `https://api.intercom.io/companies?tag_id={tag_id}`\n\n `https://api.intercom.io/companies?segment_id={segment_id}`\n", + "namespace": [ + "Companies" + ], + "displayName": "Retrieve companies", + "operationId": "retrieveCompany", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The `name` of the company to filter by." + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The `company_id` of the company to filter by." + }, + { + "key": "tag_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The `tag_id` of the company to filter by." + }, + { + "key": "segment_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The `segment_id` of the company to filter by." + }, + { + "key": "page", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The page of results to fetch. Defaults to first page" + }, + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "How many results to display per page. Defaults to 15" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company_list" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies", + "responseStatusCode": 200, + "name": "Successful", + "queryParameters": { + "name": "my company", + "company_id": "12345", + "tag_id": "678910", + "segment_id": "98765", + "page": 1, + "per_page": 15 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "remote_companies_scroll_2", + "id": "667d607e8a68186f43bafd26", + "app_id": "this_is_an_id122_that_should_be_at_least_", + "name": "IntercomQATest1", + "remote_created_at": 1719492734, + "created_at": 1719492734, + "updated_at": 1719492734, + "monthly_spend": 0, + "session_count": 0, + "user_count": 4, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 15, + "total_pages": 1 + }, + "total_count": 1 + } + } + } + ] + }, + "endpoint_companies.createOrUpdateCompany": { + "id": "endpoint_companies.createOrUpdateCompany", + "description": "You can create or update a company.\n\nCompanies will be only visible in Intercom when there is at least one associated user.\n\nCompanies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated.\n\n{% admonition type=\"attention\" name=\"Using `company_id`\" %}\n You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company.\n{% /admonition %}\n", + "namespace": [ + "Companies" + ], + "displayName": "Create or Update a company", + "operationId": "createOrUpdateCompany", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_or_update_company_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Bad Request", + "name": "Bad Request", + "examples": [ + { + "name": "Bad Request", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": null, + "errors": [ + { + "code": "bad_request", + "message": "bad 'test' parameter" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies", + "responseStatusCode": 200, + "name": "Successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "company", + "company_id": "company_remote_id", + "id": "667d607c8a68186f43bafd1e", + "app_id": "this_is_an_id116_that_should_be_at_least_", + "name": "my company", + "remote_created_at": 1374138000, + "created_at": 1719492732, + "updated_at": 1719492732, + "monthly_spend": 0, + "session_count": 0, + "user_count": 0, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": { + "creation_source": "api" + } + } + } + }, + { + "path": "/companies", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/companies", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_companies.RetrieveACompanyById": { + "id": "endpoint_companies.RetrieveACompanyById", + "description": "You can fetch a single company.", + "namespace": [ + "Companies" + ], + "displayName": "Retrieve a company by ID", + "operationId": "RetrieveACompanyById", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "test-uuid-replacement" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "company", + "company_id": "1", + "id": "667d60808a68186f43bafd31", + "app_id": "this_is_an_id128_that_should_be_at_least_", + "name": "company1", + "remote_created_at": 1719492736, + "created_at": 1719492736, + "updated_at": 1719492736, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + } + ] + }, + "endpoint_companies.UpdateCompany": { + "id": "endpoint_companies.UpdateCompany", + "description": "You can update a single company using the Intercom provisioned `id`.\n\n{% admonition type=\"attention\" name=\"Using `company_id`\" %}\n When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.\n{% /admonition %}\n", + "namespace": [ + "Companies" + ], + "displayName": "Update a company", + "operationId": "UpdateCompany", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "test-uuid-replacement" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "company", + "company_id": "1", + "id": "667d60828a68186f43bafd3b", + "app_id": "this_is_an_id134_that_should_be_at_least_", + "name": "company2", + "remote_created_at": 1719492738, + "created_at": 1719492738, + "updated_at": 1719492738, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + } + ] + }, + "endpoint_companies.deleteCompany": { + "id": "endpoint_companies.deleteCompany", + "description": "You can delete a single company.", + "namespace": [ + "Companies" + ], + "displayName": "Delete a company", + "operationId": "deleteCompany", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "deleted_company_object" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "test-uuid-replacement" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "667d60848a68186f43bafd45", + "object": "company", + "deleted": true + } + } + } + ] + }, + "endpoint_companiesContacts.ListAttachedContacts": { + "id": "endpoint_companiesContacts.ListAttachedContacts", + "description": "You can fetch a list of all contacts that belong to a company.", + "namespace": [ + "Companies", + "Contacts" + ], + "displayName": "List attached contacts", + "operationId": "ListAttachedContacts", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company_attached_contacts" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/{id}/contacts", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "test-uuid-replacement" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [], + "total_count": 0, + "pages": { + "type": "pages", + "page": 1, + "per_page": 50, + "total_pages": 0 + } + } + } + } + ] + }, + "endpoint_companies.ListAttachedSegmentsForCompanies": { + "id": "endpoint_companies.ListAttachedSegmentsForCompanies", + "description": "You can fetch a list of all segments that belong to a company.", + "namespace": [ + "Companies" + ], + "displayName": "List attached segments for companies", + "operationId": "ListAttachedSegmentsForCompanies", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "segments" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company_attached_segments" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/{id}/segments", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "test-uuid-replacement" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [] + } + } + } + ] + }, + "endpoint_companies.listAllCompanies": { + "id": "endpoint_companies.listAllCompanies", + "description": "You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first.\n\nNote that the API does not include companies who have no associated users in list responses.\n\nWhen using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies).\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "namespace": [ + "Companies" + ], + "displayName": "List all companies", + "operationId": "listAllCompanies", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "list" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The page of results to fetch. Defaults to first page" + }, + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "How many results to return per page. Defaults to 15" + }, + { + "key": "order", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company_list" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/list", + "responseStatusCode": 200, + "name": "Successful", + "queryParameters": { + "page": 1, + "per_page": 15, + "order": "desc" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "remote_companies_scroll_2", + "id": "667d608a8a68186f43bafd61", + "app_id": "this_is_an_id158_that_should_be_at_least_", + "name": "IntercomQATest1", + "remote_created_at": 1719492746, + "created_at": 1719492746, + "updated_at": 1719492746, + "monthly_spend": 0, + "session_count": 0, + "user_count": 4, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 15, + "total_pages": 1 + }, + "total_count": 1 + } + } + } + ] + }, + "endpoint_companies.scrollOverAllCompanies": { + "id": "endpoint_companies.scrollOverAllCompanies", + "description": " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset.\n\n- Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.\n- If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail\n- If the end of the scroll is reached, \"companies\" will be empty and the scroll parameter will expire\n\n{% admonition type=\"info\" name=\"Scroll Parameter\" %}\n You can get the first page of companies by simply sending a GET request to the scroll endpoint.\n For subsequent requests you will need to use the scroll parameter from the response.\n{% /admonition %}\n{% admonition type=\"danger\" name=\"Scroll network timeouts\" %}\n Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message:\n \"Request failed due to an internal network error. Please restart the scroll operation.\"\n If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll.\n{% /admonition %}\n", + "namespace": [ + "Companies" + ], + "displayName": "Scroll over all companies", + "operationId": "scrollOverAllCompanies", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "scroll" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "scroll_param", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company_scroll" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/scroll", + "responseStatusCode": 200, + "name": "Successful", + "queryParameters": { + "scroll_param": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "remote_companies_scroll_2", + "id": "667d608b8a68186f43bafd67", + "app_id": "this_is_an_id162_that_should_be_at_least_", + "name": "IntercomQATest1", + "remote_created_at": 1719492747, + "created_at": 1719492747, + "updated_at": 1719492747, + "monthly_spend": 0, + "session_count": 0, + "user_count": 4, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": null, + "total_count": null, + "scroll_param": "test-uuid-replacement" + } + } + } + ] + }, + "endpoint_contactsCompanies.listCompaniesForAContact": { + "id": "endpoint_contactsCompanies.listCompaniesForAContact", + "description": "You can fetch a list of companies that are associated to a contact.", + "namespace": [ + "Contacts", + "Companies" + ], + "displayName": "List attached companies for contact", + "operationId": "listCompaniesForAContact", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_attached_companies" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}/companies", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "1", + "id": "667d60938a68186f43bafd91", + "app_id": "this_is_an_id182_that_should_be_at_least_", + "name": "company12", + "remote_created_at": 1719492755, + "created_at": 1719492755, + "updated_at": 1719492755, + "last_request_at": 1719319955, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 50, + "total_pages": 1 + }, + "total_count": 1 + } + } + } + ] + }, + "endpoint_companiesContacts.attachContactToACompany": { + "id": "endpoint_companiesContacts.attachContactToACompany", + "description": "You can attach a company to a single contact.", + "namespace": [ + "Companies", + "Contacts" + ], + "displayName": "Attach a Contact to a Company", + "operationId": "attachContactToACompany", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Bad Request", + "name": "Bad Request", + "examples": [ + { + "name": "Bad Request", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_not_found", + "message": "company not specified" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}/companies", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "company", + "company_id": "1", + "id": "667d608d8a68186f43bafd70", + "app_id": "this_is_an_id166_that_should_be_at_least_", + "name": "company6", + "remote_created_at": 1719492749, + "created_at": 1719492749, + "updated_at": 1719492749, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + }, + { + "path": "/contacts/{id}/companies", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": "667d608d8a68186f43bafd70" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{id}/companies", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": "123" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_companiesContacts.detachContactFromACompany": { + "id": "endpoint_companiesContacts.detachContactFromACompany", + "description": "You can detach a company from a single contact.", + "namespace": [ + "Companies", + "Contacts" + ], + "displayName": "Detach a contact from a company", + "operationId": "detachContactFromACompany", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + }, + { + "name": "Contact Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/companies/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "contact_id": "58a430d35458202d41b1e65b", + "id": "58a430d35458202d41b1e65b" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "company", + "company_id": "1", + "id": "667d60918a68186f43bafd80", + "app_id": "this_is_an_id174_that_should_be_at_least_", + "name": "company8", + "remote_created_at": 1719492753, + "created_at": 1719492753, + "updated_at": 1719492753, + "monthly_spend": 0, + "session_count": 0, + "user_count": 0, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + } + ] + }, + "endpoint_notesContacts.listNotes": { + "id": "endpoint_notesContacts.listNotes", + "description": "You can fetch a list of notes that are associated to a contact.", + "namespace": [ + "Notes", + "Contacts" + ], + "displayName": "List all notes", + "operationId": "listNotes", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "notes" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier of a contact." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "note_list" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}/notes", + "responseStatusCode": 200, + "name": "Successful response", + "pathParameters": { + "id": 0 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "note", + "id": "29", + "created_at": 1718887958, + "contact": { + "type": "contact", + "id": "667d60968a68186f43bafd9c" + }, + "author": { + "type": "admin", + "id": "991267491", + "name": "Ciaran101 Lee", + "email": "admin101@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + }, + { + "type": "note", + "id": "28", + "created_at": 1718801558, + "contact": { + "type": "contact", + "id": "667d60968a68186f43bafd9c" + }, + "author": { + "type": "admin", + "id": "991267491", + "name": "Ciaran101 Lee", + "email": "admin101@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + }, + { + "type": "note", + "id": "27", + "created_at": 1718801558, + "contact": { + "type": "contact", + "id": "667d60968a68186f43bafd9c" + }, + "author": { + "type": "admin", + "id": "991267491", + "name": "Ciaran101 Lee", + "email": "admin101@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + } + ], + "total_count": 3, + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 50, + "total_pages": 1 + } + } + } + } + ] + }, + "endpoint_notesContacts.createNote": { + "id": "endpoint_notesContacts.createNote", + "description": "You can add a note to a single contact.", + "namespace": [ + "Notes", + "Contacts" + ], + "displayName": "Create a note", + "operationId": "createNote", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "notes" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier of a given contact." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The text of the note." + }, + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier of a given contact." + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier of a given admin." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "note" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Admin not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + }, + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}/notes", + "responseStatusCode": 200, + "name": "Successful response", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "note", + "id": "34", + "created_at": 1719492759, + "contact": { + "type": "contact", + "id": "667d60978a68186f43bafd9e" + }, + "author": { + "type": "admin", + "id": "991267493", + "name": "Ciaran103 Lee", + "email": "admin103@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

Hello

" + } + } + }, + { + "path": "/contacts/{id}/notes", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "contact_id": "667d60978a68186f43bafd9e", + "admin_id": 991267493, + "body": "Hello" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{id}/notes", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "contact_id": "667d60988a68186f43bafd9f", + "admin_id": 123, + "body": "Hello" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{id}/notes", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "contact_id": 123, + "admin_id": 991267495, + "body": "Hello" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_contactsSegments.listSegmentsForAContact": { + "id": "endpoint_contactsSegments.listSegmentsForAContact", + "description": "You can fetch a list of segments that are associated to a contact.", + "namespace": [ + "Contacts", + "Segments" + ], + "displayName": "List attached segments for contact", + "operationId": "listSegmentsForAContact", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "segments" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_segments" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/segments", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "segment", + "id": "667d60998a68186f43bafda1", + "name": "segment", + "created_at": 1719492761, + "updated_at": 1719492761, + "person_type": "user" + } + ] + } + } + } + ] + }, + "endpoint_contactsSubscriptionTypes.listSubscriptionsForAContact": { + "id": "endpoint_contactsSubscriptionTypes.listSubscriptionsForAContact", + "description": "You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type.\nThis will return a list of Subscription Type objects that the contact is associated with.\n\nThe data property will show a combined list of:\n\n 1.Opt-out subscription types that the user has opted-out from.\n 2.Opt-in subscription types that the user has opted-in to receiving.\n", + "namespace": [ + "Contacts", + "Subscription Types" + ], + "displayName": "List subscriptions for a contact", + "operationId": "listSubscriptionsForAContact", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "subscriptions" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "subscription_type_list" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/subscriptions", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "subscription", + "id": "93", + "state": "live", + "consent_type": "opt_out", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "email" + ] + }, + { + "type": "subscription", + "id": "95", + "state": "live", + "consent_type": "opt_in", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "sms_message" + ] + } + ] + } + } + } + ] + }, + "endpoint_subscriptionTypesContacts.attachSubscriptionTypeToContact": { + "id": "endpoint_subscriptionTypesContacts.attachSubscriptionTypeToContact", + "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", + "namespace": [ + "Subscription Types", + "Contacts" + ], + "displayName": "Add subscription to a contact", + "operationId": "attachSubscriptionTypeToContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "subscriptions" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the subscription which is given by Intercom" + }, + { + "key": "consent_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The consent_type of a subscription, opt_out or opt_in." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "subscription_type" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Resource not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + }, + { + "name": "Resource not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/subscriptions", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "subscription", + "id": "108", + "state": "live", + "consent_type": "opt_in", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "sms_message" + ] + } + } + }, + { + "path": "/contacts/{contact_id}/subscriptions", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 108, + "consent_type": "opt_in" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{contact_id}/subscriptions", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 112, + "consent_type": "opt_in" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{contact_id}/subscriptions", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": "invalid_id", + "consent_type": "opt_in" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_subscriptionTypesContacts.detachSubscriptionTypeToContact": { + "id": "endpoint_subscriptionTypesContacts.detachSubscriptionTypeToContact", + "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "namespace": [ + "Subscription Types", + "Contacts" + ], + "displayName": "Remove subscription from a contact", + "operationId": "detachSubscriptionTypeToContact", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "subscriptions" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the subscription type which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "subscription_type" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Resource not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + }, + { + "name": "Resource not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/subscriptions/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965", + "id": "37846" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "subscription", + "id": "124", + "state": "live", + "consent_type": "opt_in", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "sms_message" + ] + } + } + } + ] + }, + "endpoint_contactsTags.listTagsForAContact": { + "id": "endpoint_contactsTags.listTagsForAContact", + "description": "You can fetch a list of all tags that are attached to a specific contact.", + "namespace": [ + "Contacts", + "Tags" + ], + "displayName": "List tags attached to a contact", + "operationId": "listTagsForAContact", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "tag", + "id": "93", + "name": "Manual tag" + } + ] + } + } + } + ] + }, + "endpoint_tagsContacts.attachTagToContact": { + "id": "endpoint_tagsContacts.attachTagToContact", + "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "namespace": [ + "Tags", + "Contacts" + ], + "displayName": "Add tag to a contact", + "operationId": "attachTagToContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the tag which is given by Intercom" + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + }, + { + "name": "Tag not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "94", + "name": "Manual tag" + } + } + }, + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 94 + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "94", + "name": "Manual tag" + } + } + }, + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 94 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 95 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": "123" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tagsContacts.detachTagFromContact": { + "id": "endpoint_tagsContacts.detachTagFromContact", + "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "namespace": [ + "Tags", + "Contacts" + ], + "displayName": "Remove tag from a contact", + "operationId": "detachTagFromContact", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the tag which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + }, + { + "name": "Tag not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/tags/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "97", + "name": "Manual tag" + } + } + } + ] + }, + "endpoint_contacts.ShowContact": { + "id": "endpoint_contacts.ShowContact", + "description": "You can fetch the details of a single contact.", + "namespace": [ + "Contacts" + ], + "displayName": "Get a contact", + "operationId": "ShowContact", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60a98a68186f43bafdb9", + "workspace_id": "this_is_an_id252_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joe@bloggs.com", + "phone": null, + "name": "Joe Bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492777, + "updated_at": 1719492777, + "signed_up_at": 1719492777, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + } + ] + }, + "endpoint_contacts.UpdateContact": { + "id": "endpoint_contacts.UpdateContact", + "description": "You can update an existing contact (ie. user or lead).", + "namespace": [ + "Contacts" + ], + "displayName": "Update a contact", + "operationId": "UpdateContact", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60a88a68186f43bafdb8", + "workspace_id": "this_is_an_id248_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joebloggs@intercom.io", + "phone": null, + "name": "joe bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492776, + "updated_at": 1719492776, + "signed_up_at": 1719492776, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "email": "joebloggs@intercom.io", + "name": "joe bloggs" + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60a88a68186f43bafdb8", + "workspace_id": "this_is_an_id248_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joebloggs@intercom.io", + "phone": null, + "name": "joe bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492776, + "updated_at": 1719492776, + "signed_up_at": 1719492776, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "email": "joebloggs@intercom.io", + "name": "joe bloggs" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_contacts.DeleteContact": { + "id": "endpoint_contacts.DeleteContact", + "description": "You can delete a single contact.", + "namespace": [ + "Contacts" + ], + "displayName": "Delete a contact", + "operationId": "DeleteContact", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_deleted" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "667d60aa8a68186f43bafdba", + "external_id": "70", + "type": "contact", + "deleted": true + } + } + } + ] + }, + "endpoint_contacts.MergeContact": { + "id": "endpoint_contacts.MergeContact", + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "namespace": [ + "Contacts" + ], + "displayName": "Merge a lead and a user", + "operationId": "MergeContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "merge" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "merge_contacts_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/merge", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60ac8a68186f43bafdbc", + "workspace_id": "this_is_an_id260_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joe@bloggs.com", + "phone": null, + "name": "Joe Bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492780, + "updated_at": 1719492780, + "signed_up_at": 1719492780, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts/merge", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60ac8a68186f43bafdbc", + "workspace_id": "this_is_an_id260_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joe@bloggs.com", + "phone": null, + "name": "Joe Bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492780, + "updated_at": 1719492780, + "signed_up_at": 1719492780, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts/merge", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_contacts.SearchContacts": { + "id": "endpoint_contacts.SearchContacts", + "description": "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for contacts.\n\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n### Contact Creation Delay\n\nIf a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n* There's a limit of max 2 nested filters\n* There's a limit of max 15 filters for each AND or OR group\n\n### Searching for Timestamp Fields\n\nAll timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second.\nFor example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards.\nIf you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM).\nThis behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.\n\n### Accepted Fields\n\nMost key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\n\n| Field | Type |\n| ---------------------------------- | ------------------------------ |\n| id | String |\n| role | String
Accepts user or lead |\n| name | String |\n| avatar | String |\n| owner_id | Integer |\n| email | String |\n| email_domain | String |\n| phone | String |\n| formatted_phone | String |\n| external_id | String |\n| created_at | Date (UNIX Timestamp) |\n| signed_up_at | Date (UNIX Timestamp) |\n| updated_at | Date (UNIX Timestamp) |\n| last_seen_at | Date (UNIX Timestamp) |\n| last_contacted_at | Date (UNIX Timestamp) |\n| last_replied_at | Date (UNIX Timestamp) |\n| last_email_opened_at | Date (UNIX Timestamp) |\n| last_email_clicked_at | Date (UNIX Timestamp) |\n| language_override | String |\n| browser | String |\n| browser_language | String |\n| os | String |\n| location.country | String |\n| location.region | String |\n| location.city | String |\n| unsubscribed_from_emails | Boolean |\n| marked_email_as_spam | Boolean |\n| has_hard_bounced | Boolean |\n| ios_last_seen_at | Date (UNIX Timestamp) |\n| ios_app_version | String |\n| ios_device | String |\n| ios_app_device | String |\n| ios_os_version | String |\n| ios_app_name | String |\n| ios_sdk_version | String |\n| android_last_seen_at | Date (UNIX Timestamp) |\n| android_app_version | String |\n| android_device | String |\n| android_app_name | String |\n| andoid_sdk_version | String |\n| segment_id | String |\n| tag_id | String |\n| custom_attributes.{attribute_name} | String |\n\n### Accepted Operators\n\n{% admonition type=\"attention\" name=\"Searching based on `created_at`\" %}\n You cannot use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :------------------------------- | :--------------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In
Shortcut for `OR` queries
Values must be in Array |\n| NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array |\n| > | Integer
Date (UNIX Timestamp) | Greater than |\n| < | Integer
Date (UNIX Timestamp) | Lower than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "namespace": [ + "Contacts" + ], + "displayName": "Search contacts", + "operationId": "SearchContacts", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "search" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "search_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [], + "total_count": 0, + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 0 + } + } + } + }, + { + "path": "/contacts/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [], + "total_count": 0, + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 0 + } + } + } + }, + { + "path": "/contacts/search", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_contacts.ListContacts": { + "id": "endpoint_contacts.ListContacts", + "description": "You can fetch a list of all contacts (ie. users or leads) in your workspace.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "namespace": [ + "Contacts" + ], + "displayName": "List all contacts", + "operationId": "ListContacts", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [], + "total_count": 0, + "pages": { + "type": "pages", + "page": 1, + "per_page": 10, + "total_pages": 0 + } + } + } + } + ] + }, + "endpoint_contacts.CreateContact": { + "id": "endpoint_contacts.CreateContact", + "description": "You can create a new contact (ie. user or lead).", + "namespace": [ + "Contacts" + ], + "displayName": "Create contact", + "operationId": "CreateContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60b08a68186f43bafdbf", + "workspace_id": "this_is_an_id272_that_should_be_at_least_", + "external_id": null, + "role": "user", + "email": "joebloggs@intercom.io", + "phone": null, + "name": null, + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492784, + "updated_at": 1719492784, + "signed_up_at": null, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "email": "joebloggs@intercom.io" + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60b08a68186f43bafdbf", + "workspace_id": "this_is_an_id272_that_should_be_at_least_", + "external_id": null, + "role": "user", + "email": "joebloggs@intercom.io", + "phone": null, + "name": null, + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492784, + "updated_at": 1719492784, + "signed_up_at": null, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "email": "joebloggs@intercom.io" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_contacts.ArchiveContact": { + "id": "endpoint_contacts.ArchiveContact", + "description": "You can archive a single contact.", + "namespace": [ + "Contacts" + ], + "displayName": "Archive contact", + "operationId": "ArchiveContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "archive" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_archived" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/contacts/{id}/archive", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "667d60b18a68186f43bafdc0", + "external_id": "70", + "type": "contact", + "archived": true + } + } + } + ] + }, + "endpoint_contacts.UnarchiveContact": { + "id": "endpoint_contacts.UnarchiveContact", + "description": "You can unarchive a single contact.", + "namespace": [ + "Contacts" + ], + "displayName": "Unarchive contact", + "operationId": "UnarchiveContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "unarchive" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_unarchived" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/contacts/{id}/unarchive", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "667d60b28a68186f43bafdc1", + "external_id": "70", + "type": "contact", + "archived": false + } + } + } + ] + }, + "endpoint_tagsConversations.attachTagToConversation": { + "id": "endpoint_tagsConversations.attachTagToConversation", + "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "namespace": [ + "Tags", + "Conversations" + ], + "displayName": "Add tag to a conversation", + "operationId": "attachTagToConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "conversation_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "conversation_id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the tag which is given by Intercom" + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the admin which is given by Intercom." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Conversation not found", + "name": "Not Found", + "examples": [ + { + "name": "Conversation not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Conversation not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{conversation_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "conversation_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "99", + "name": "Manual tag" + } + } + }, + { + "path": "/conversations/{conversation_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "conversation_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 99, + "admin_id": 991267526 + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "99", + "name": "Manual tag" + } + } + }, + { + "path": "/conversations/{conversation_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 99, + "admin_id": 991267526 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 100, + "admin_id": 991267528 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tagsConversations.detachTagFromConversation": { + "id": "endpoint_tagsConversations.detachTagFromConversation", + "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "namespace": [ + "Tags", + "Conversations" + ], + "displayName": "Remove tag from a conversation", + "operationId": "detachTagFromConversation", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "conversation_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "conversation_id" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the admin which is given by Intercom." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag not found", + "name": "Not Found", + "examples": [ + { + "name": "Conversation not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Conversation not found" + } + ] + } + } + }, + { + "name": "Tag not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "tag_not_found", + "message": "Tag not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{conversation_id}/tags/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "conversation_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "102", + "name": "Manual tag" + } + } + }, + { + "path": "/conversations/{conversation_id}/tags/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "conversation_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267530 + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "102", + "name": "Manual tag" + } + } + }, + { + "path": "/conversations/{conversation_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267530 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267532 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267533 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.listConversations": { + "id": "endpoint_conversations.listConversations", + "description": "You can fetch a list of all conversations.\n\nYou can optionally request the result page size and the cursor to start after to fetch the result.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "namespace": [ + "Conversations" + ], + "displayName": "List all conversations", + "operationId": "listConversations", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer", + "maximum": 150, + "default": 20 + } + } + } + } + }, + "description": "How many results per page" + }, + { + "key": "starting_after", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "String used to get the next page of conversations." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "paginated_response" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations", + "responseStatusCode": 200, + "name": "successful", + "queryParameters": { + "per_page": 20, + "starting_after": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 20, + "total_pages": 1 + }, + "total_count": 1, + "conversations": [ + { + "type": "conversation", + "id": "335", + "created_at": 1719492795, + "updated_at": 1719492795, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918241", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267536", + "name": "Ciaran143 Lee", + "email": "admin143@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60bb8a68186f43bafdc5", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false + } + ] + } + } + } + ] + }, + "endpoint_conversations.createConversation": { + "id": "endpoint_conversations.createConversation", + "description": "You can create a conversation that has been initiated by a contact (ie. user or lead).\nThe conversation can be an in-app message only.\n\n{% admonition type=\"info\" name=\"Sending for visitors\" %}\nYou can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`.\nThis visitor will be automatically converted to a contact with a lead role once the conversation is created.\n{% /admonition %}\n\nThis will return the Message model that has been created.\n\n", + "namespace": [ + "Conversations" + ], + "displayName": "Creates a conversation", + "operationId": "createConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "message" + } + }, + "description": "conversation created" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Contact Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations", + "responseStatusCode": 200, + "name": "conversation created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "user_message", + "id": "403918251", + "created_at": 1719492819, + "body": "Hello there", + "message_type": "inapp", + "conversation_id": "363" + } + } + }, + { + "path": "/conversations", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.retrieveConversation": { + "id": "endpoint_conversations.retrieveConversation", + "description": "\nYou can fetch the details of a single conversation.\n\nThis will return a single Conversation model with all its conversation parts.\n\n{% admonition type=\"warning\" name=\"Hard limit of 500 parts\" %}\nThe maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts.\n{% /admonition %}\n\nFor AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671).\n", + "namespace": [ + "Conversations" + ], + "displayName": "Retrieve a conversation", + "operationId": "retrieveConversation", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the conversation to target" + } + ], + "queryParameters": [ + { + "key": "display_as", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "conversation found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}", + "responseStatusCode": 200, + "name": "conversation found", + "pathParameters": { + "id": 123 + }, + "queryParameters": { + "display_as": "plaintext" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "367", + "created_at": 1719492825, + "updated_at": 1719492825, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918255", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267553", + "name": "Ciaran153 Lee", + "email": "admin153@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60d88a68186f43bafde1", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [], + "total_count": 0 + } + } + } + } + ] + }, + "endpoint_conversations.updateConversation": { + "id": "endpoint_conversations.updateConversation", + "description": "\nYou can update an existing conversation.\n\n{% admonition type=\"info\" name=\"Replying and other actions\" %}\nIf you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints.\n{% /admonition %}\n\n", + "namespace": [ + "Conversations" + ], + "displayName": "Update a conversation", + "operationId": "updateConversation", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the conversation to target" + } + ], + "queryParameters": [ + { + "key": "display_as", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "conversation found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}", + "responseStatusCode": 200, + "name": "conversation found", + "pathParameters": { + "id": 123 + }, + "queryParameters": { + "display_as": "plaintext" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "371", + "created_at": 1719492832, + "updated_at": 1719492834, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918259", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267561", + "name": "Ciaran157 Lee", + "email": "admin157@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60e08a68186f43bafde5", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": true, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": { + "issue_type": "Billing", + "priority": "High" + }, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "96", + "part_type": "conversation_attribute_updated_by_admin", + "body": null, + "created_at": 1719492834, + "updated_at": 1719492834, + "notified_at": 1719492834, + "assigned_to": null, + "author": { + "id": "991267562", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "external_id": null, + "redacted": false + }, + { + "type": "conversation_part", + "id": "97", + "part_type": "conversation_attribute_updated_by_admin", + "body": null, + "created_at": 1719492834, + "updated_at": 1719492834, + "notified_at": 1719492834, + "assigned_to": null, + "author": { + "id": "991267562", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 2 + } + } + } + }, + { + "path": "/conversations/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "queryParameters": { + "display_as": "plaintext" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "queryParameters": { + "display_as": "plaintext" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.searchConversations": { + "id": "endpoint_conversations.searchConversations", + "description": "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for conversations.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the The conversation model is searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\n\n| Field | Type |\n| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. |\n| source.id | String |\n| source.delivered_as | String |\n| source.subject | String |\n| source.body | String |\n| source.author.id | String |\n| source.author.type | String |\n| source.author.name | String |\n| source.author.email | String |\n| source.url | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | String |\n| team_assignee_id | String |\n| channel_initiated | String |\n| open | Boolean |\n| read | Boolean |\n| state | String |\n| waiting_since | Date (UNIX timestamp) |\n| snoozed_until | Date (UNIX timestamp) |\n| tag_ids | String |\n| priority | String |\n| statistics.time_to_assignment | Integer |\n| statistics.time_to_admin_reply | Integer |\n| statistics.time_to_first_close | Integer |\n| statistics.time_to_last_close | Integer |\n| statistics.median_time_to_reply | Integer |\n| statistics.first_contact_reply_at | Date (UNIX timestamp) |\n| statistics.first_assignment_at | Date (UNIX timestamp) |\n| statistics.first_admin_reply_at | Date (UNIX timestamp) |\n| statistics.first_close_at | Date (UNIX timestamp) |\n| statistics.last_assignment_at | Date (UNIX timestamp) |\n| statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) |\n| statistics.last_contact_reply_at | Date (UNIX timestamp) |\n| statistics.last_admin_reply_at | Date (UNIX timestamp) |\n| statistics.last_close_at | Date (UNIX timestamp) |\n| statistics.last_closed_by_id | String |\n| statistics.count_reopens | Integer |\n| statistics.count_assignments | Integer |\n| statistics.count_conversation_parts | Integer |\n| conversation_rating.requested_at | Date (UNIX timestamp) |\n| conversation_rating.replied_at | Date (UNIX timestamp) |\n| conversation_rating.score | Integer |\n| conversation_rating.remark | String |\n| conversation_rating.contact_id | String |\n| conversation_rating.admin_d | String |\n| ai_agent_participated | Boolean |\n| ai_agent.resolution_state | String |\n| ai_agent.last_answer_type | String |\n| ai_agent.rating | Integer |\n| ai_agent.rating_remark | String |\n| ai_agent.source_type | String |\n| ai_agent.source_title | String |\n\n### Accepted Operators\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "namespace": [ + "Conversations" + ], + "displayName": "Search conversations", + "operationId": "searchConversations", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "search" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "search_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_list" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/conversations/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 1 + }, + "total_count": 1, + "conversations": [ + { + "type": "conversation", + "id": "378", + "created_at": 1719492843, + "updated_at": 1719492843, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918266", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267591", + "name": "Ciaran180 Lee", + "email": "admin180@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60ea8a68186f43bafdec", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false + } + ] + } + } + }, + { + "path": "/conversations/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 1 + }, + "total_count": 1, + "conversations": [ + { + "type": "conversation", + "id": "378", + "created_at": 1719492843, + "updated_at": 1719492843, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918266", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267591", + "name": "Ciaran180 Lee", + "email": "admin180@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60ea8a68186f43bafdec", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false + } + ] + } + } + }, + { + "path": "/conversations/search", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.replyConversation": { + "id": "endpoint_conversations.replyConversation", + "description": "You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.", + "namespace": [ + "Conversations" + ], + "displayName": "Reply to a conversation", + "operationId": "replyConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "reply" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom provisioned identifier for the conversation or the string \"last\" to reply to the last part of the conversation" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "reply_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "User last conversation reply" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "name": "User reply", + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "387", + "created_at": 1719492849, + "updated_at": 1719492850, + "waiting_since": 1719492850, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918269", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267594", + "name": "Ciaran182 Lee", + "email": "admin182@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60f18a68186f43bafdf4", + "external_id": "70" + } + ] + }, + "first_contact_reply": { + "created_at": 1719492850, + "type": "conversation", + "url": null + }, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "99", + "part_type": "open", + "body": "

Thanks again :)

", + "created_at": 1719492850, + "updated_at": 1719492850, + "notified_at": 1719492850, + "assigned_to": null, + "author": { + "id": "667d60f18a68186f43bafdf4", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "name": "Admin note reply", + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "388", + "created_at": 1719492852, + "updated_at": 1719492853, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918270", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267596", + "name": "Ciaran183 Lee", + "email": "admin183@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60f38a68186f43bafdf5", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "100", + "part_type": "note", + "body": "

An Unordered HTML List

\n
    \n
  • Coffee
    • \n
  • Tea
    • \n
  • Milk
    • \n
\n

An Ordered HTML List

\n
    \n
  1. Coffee
    2. \n
  2. Tea
    3. \n
  3. Milk
    4. \n
", + "created_at": 1719492853, + "updated_at": 1719492853, + "notified_at": 1719492853, + "assigned_to": null, + "author": { + "id": "991267596", + "type": "admin", + "name": "Ciaran183 Lee", + "email": "admin183@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "name": "User last conversation reply", + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "390", + "created_at": 1719492855, + "updated_at": 1719492856, + "waiting_since": 1719492856, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918272", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267600", + "name": "Ciaran185 Lee", + "email": "admin185@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60f78a68186f43bafdf7", + "external_id": "70" + } + ] + }, + "first_contact_reply": { + "created_at": 1719492856, + "type": "conversation", + "url": null + }, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "101", + "part_type": "open", + "body": "

Thanks again :)

", + "created_at": 1719492856, + "updated_at": 1719492856, + "notified_at": 1719492856, + "assigned_to": null, + "author": { + "id": "667d60f78a68186f43bafdf7", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.manageConversation": { + "id": "endpoint_conversations.manageConversation", + "description": "For managing conversations you can:\n- Close a conversation\n- Snooze a conversation to reopen on a future date\n- Open a conversation which is `snoozed` or `closed`\n- Assign a conversation to an admin and/or team.\n", + "namespace": [ + "Conversations" + ], + "displayName": "Manage a conversation", + "operationId": "manageConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "parts" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the conversation as given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "Assign a conversation" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "name": "Close a conversation", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "394", + "created_at": 1719492862, + "updated_at": 1719492862, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918276", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267608", + "name": "Ciaran189 Lee", + "email": "admin189@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60fd8a68186f43bafdfb", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "102", + "part_type": "close", + "body": "

Goodbye :)

", + "created_at": 1719492862, + "updated_at": 1719492862, + "notified_at": 1719492862, + "assigned_to": null, + "author": { + "id": "991267608", + "type": "admin", + "name": "Ciaran189 Lee", + "email": "admin189@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "name": "Snooze a conversation", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "395", + "created_at": 1719492864, + "updated_at": 1719492864, + "waiting_since": null, + "snoozed_until": 1719496464, + "source": { + "type": "conversation", + "id": "403918277", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267610", + "name": "Ciaran190 Lee", + "email": "admin190@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60ff8a68186f43bafdfc", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "snoozed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "103", + "part_type": "snoozed", + "body": null, + "created_at": 1719492864, + "updated_at": 1719492864, + "notified_at": 1719492864, + "assigned_to": null, + "author": { + "id": "991267610", + "type": "admin", + "name": "Ciaran190 Lee", + "email": "admin190@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "name": "Open a conversation", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "400", + "created_at": 1719492863, + "updated_at": 1719492873, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918278", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267612", + "name": "Ciaran191 Lee", + "email": "admin191@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61038a68186f43bafe01", + "external_id": "74" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": true, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": "", + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "105", + "part_type": "open", + "body": null, + "created_at": 1719492873, + "updated_at": 1719492873, + "notified_at": 1719492873, + "assigned_to": null, + "author": { + "id": "991267612", + "type": "admin", + "name": "Ciaran191 Lee", + "email": "admin191@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "name": "Assign a conversation", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "405", + "created_at": 1719492874, + "updated_at": 1719492875, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918281", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267615", + "name": "Ciaran193 Lee", + "email": "admin193@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d610a8a68186f43bafe05", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": 991267615, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "106", + "part_type": "assign_and_reopen", + "body": null, + "created_at": 1719492875, + "updated_at": 1719492875, + "notified_at": 1719492875, + "assigned_to": { + "type": "admin", + "id": "991267615" + }, + "author": { + "id": "991267615", + "type": "admin", + "name": "Ciaran193 Lee", + "email": "admin193@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "close", + "type": "admin", + "admin_id": 991267608, + "body": "Goodbye :)" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "snoozed", + "admin_id": 991267610, + "snoozed_until": 1719496464 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "open", + "admin_id": 991267612 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "assignment", + "type": "admin", + "admin_id": 991267615, + "assignee_id": 991267615 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "close", + "type": "admin", + "admin_id": 991267617, + "body": "Goodbye :)" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.autoAssignConversation": { + "id": "endpoint_conversations.autoAssignConversation", + "description": "You can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"attention\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", + "namespace": [ + "Conversations" + ], + "displayName": "Run Assignment Rules on a conversation", + "operationId": "autoAssignConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "run_assignment_rules" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the conversation as given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "Assign a conversation using assignment rules" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}/run_assignment_rules", + "responseStatusCode": 200, + "name": "Assign a conversation using assignment rules", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "409", + "created_at": 1719492880, + "updated_at": 1719492881, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918285", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267623", + "name": "Ciaran197 Lee", + "email": "admin197@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61108a68186f43bafe09", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "107", + "part_type": "default_assignment", + "body": null, + "created_at": 1719492881, + "updated_at": 1719492881, + "notified_at": 1719492881, + "assigned_to": { + "type": "nobody_admin", + "id": null + }, + "author": { + "id": "991267624", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id364_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + } + ] + }, + "endpoint_conversations.attachContactToConversation": { + "id": "endpoint_conversations.attachContactToConversation", + "description": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.\n\n{% admonition type=\"attention\" name=\"Contacts without an email\" %}\nIf you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.\n{% /admonition %}\n\n", + "namespace": [ + "Conversations" + ], + "displayName": "Attach a contact to a conversation", + "operationId": "attachContactToConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "customers" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the conversation as given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "attach_contact_to_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "Attach a contact to a conversation" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}/customers", + "responseStatusCode": 200, + "name": "Attach a contact to a conversation", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "customers": [ + { + "type": "user", + "id": "667d61168a68186f43bafe0d" + } + ] + } + } + }, + { + "path": "/conversations/{id}/customers", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/customers", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.detachContactFromConversation": { + "id": "endpoint_conversations.detachContactFromConversation", + "description": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.\n\n{% admonition type=\"attention\" name=\"Contacts without an email\" %}\nIf you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.\n{% /admonition %}\n\n", + "namespace": [ + "Conversations" + ], + "displayName": "Detach a contact from a group conversation", + "operationId": "detachContactFromConversation", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "conversation_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "customers" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the conversation as given by Intercom." + }, + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "detach_contact_from_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "Detach a contact from a group conversation" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Conversation not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + }, + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Last customer", + "name": "Unprocessable Entity", + "examples": [ + { + "name": "Last customer", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Removing the last customer is not allowed" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "responseStatusCode": 200, + "name": "Detach a contact from a group conversation", + "pathParameters": { + "conversation_id": "123", + "contact_id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "customers": [ + { + "type": "user", + "id": "667d61228a68186f43bafe19" + } + ] + } + } + }, + { + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "123", + "contact_id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "123", + "contact_id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "123", + "contact_id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "123", + "contact_id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.redactConversation": { + "id": "endpoint_conversations.redactConversation", + "description": "You can redact a conversation part or the source message of a conversation (as seen in the source object).\n\n{% admonition type=\"info\" name=\"Redacting parts and messages\" %}\nIf you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met.\n{% /admonition %}\n\n", + "namespace": [ + "Conversations" + ], + "displayName": "Redact a conversation part", + "operationId": "redactConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "redact" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "redact_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "Redact a conversation part" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "conversation_part_or_message_not_found", + "message": "Conversation part or message not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/redact", + "responseStatusCode": 200, + "name": "Redact a conversation part", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "471", + "created_at": 1719492938, + "updated_at": 1719492940, + "waiting_since": 1719492939, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918311", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267657", + "name": "Ciaran217 Lee", + "email": "admin217@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d614a8a68186f43bafe42", + "external_id": "70" + } + ] + }, + "first_contact_reply": { + "created_at": 1719492939, + "type": "conversation", + "url": null + }, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": true, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "115", + "part_type": "open", + "body": "

This message was deleted

", + "created_at": 1719492939, + "updated_at": 1719492940, + "notified_at": 1719492939, + "assigned_to": null, + "author": { + "id": "667d614a8a68186f43bafe42", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "external_id": null, + "redacted": true + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/redact", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/redact", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.convertConversationToTicket": { + "id": "endpoint_conversations.convertConversationToTicket", + "description": "You can convert a conversation to a ticket.", + "namespace": [ + "Conversations" + ], + "displayName": "Convert a conversation to a ticket", + "operationId": "convertConversationToTicket", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "convert" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the conversation to target" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "convert_conversation_to_ticket_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Bad request", + "name": "Bad Request", + "examples": [ + { + "name": "Bad request", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Ticket type is not a customer ticket type" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}/convert", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket", + "id": "474", + "ticket_id": "37", + "ticket_attributes": {}, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "79", + "name": "my-ticket-type-1", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id404_that_should_be_at_least_", + "archived": false, + "created_at": 1719492947, + "updated_at": 1719492947, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [] + }, + "category": "Customer" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61518a68186f43bafe45", + "external_id": "70" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719492945, + "updated_at": 1719492947, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "117", + "part_type": "comment", + "body": "

Comment for message

", + "created_at": 1719492945, + "updated_at": 1719492945, + "author": { + "id": "667d61518a68186f43bafe45", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "118", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719492947, + "updated_at": 1719492947, + "author": { + "id": "991267667", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id404_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 2 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Customer", + "is_shared": true, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + } + }, + { + "path": "/conversations/{id}/convert", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket", + "id": "474", + "ticket_id": "37", + "ticket_attributes": {}, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "79", + "name": "my-ticket-type-1", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id404_that_should_be_at_least_", + "archived": false, + "created_at": 1719492947, + "updated_at": 1719492947, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [] + }, + "category": "Customer" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61518a68186f43bafe45", + "external_id": "70" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719492945, + "updated_at": 1719492947, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "117", + "part_type": "comment", + "body": "

Comment for message

", + "created_at": 1719492945, + "updated_at": 1719492945, + "author": { + "id": "667d61518a68186f43bafe45", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "118", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719492947, + "updated_at": 1719492947, + "author": { + "id": "991267667", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id404_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 2 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Customer", + "is_shared": true, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + } + }, + { + "path": "/conversations/{id}/convert", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/convert", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_dataAttributes.lisDataAttributes": { + "id": "endpoint_dataAttributes.lisDataAttributes", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "namespace": [ + "Data Attributes" + ], + "displayName": "List all data attributes", + "operationId": "lisDataAttributes", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data_attributes" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "model", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "enum", + "values": [ + { + "value": "contact" + }, + { + "value": "company" + }, + { + "value": "conversation" + } + ] + } + } + }, + "description": "Specify the data attribute model to return." + }, + { + "key": "include_archived", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Include archived attributes in the list. By default we return only non archived data attributes." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_attribute_list" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/data_attributes", + "responseStatusCode": 200, + "name": "Successful response", + "queryParameters": { + "model": "company", + "include_archived": false + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "data_attribute", + "name": "name", + "full_name": "name", + "label": "Company name", + "description": "The name of a company", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "company_id", + "full_name": "company_id", + "label": "Company ID", + "description": "A number identifying a company", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "last_request_at", + "full_name": "last_request_at", + "label": "Company last seen", + "description": "The last day anyone from a company visited your site or app", + "data_type": "date", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "remote_created_at", + "full_name": "remote_created_at", + "label": "Company created at", + "description": "The day a company was added to Intercom", + "data_type": "date", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "user_count", + "full_name": "user_count", + "label": "People", + "description": "The number of people in a company", + "data_type": "integer", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "session_count", + "full_name": "session_count", + "label": "Company web sessions", + "description": "All visits from anyone in a company to your product's site or app", + "data_type": "integer", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "name", + "full_name": "plan.name", + "label": "Plan", + "description": "A specific plan or level within your product that companies have signed up to", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "monthly_spend", + "full_name": "monthly_spend", + "label": "Monthly Spend", + "description": "The monthly revenue you receive from a company", + "data_type": "float", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "size", + "full_name": "size", + "label": "Company size", + "description": "The number of people employed in this company, expressed as a single number", + "data_type": "integer", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "industry", + "full_name": "industry", + "label": "Company industry", + "description": "The category or domain this company belongs to e.g. 'ecommerce' or 'SaaS'", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "website", + "full_name": "website", + "label": "Company website", + "description": "The web address for the company's primary marketing site", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "id": 34, + "type": "data_attribute", + "name": "The One Ring", + "full_name": "custom_attributes.The One Ring", + "label": "The One Ring", + "description": "One ring to rule them all, one ring to find them, One ring to bring them all and in the darkness bind them.", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": true, + "archived": false, + "admin_id": "991267684", + "created_at": 1719492954, + "updated_at": 1719492954, + "model": "company" + }, + { + "type": "data_attribute", + "name": "id", + "full_name": "id", + "label": "ID", + "description": "The Intercom defined id representing the company", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "created_at", + "full_name": "created_at", + "label": "Created at", + "description": "The time the company was added to Intercom", + "data_type": "date", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "updated_at", + "full_name": "updated_at", + "label": "Updated at", + "description": "The last time the company was updated", + "data_type": "date", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "id", + "full_name": "plan.id", + "label": "Plan ID", + "description": "The Intercom defined id representing the plan", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "app_id", + "full_name": "app_id", + "label": "App ID", + "description": "The Intercom defined id representing the app", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + } + ] + } + } + } + ] + }, + "endpoint_dataAttributes.createDataAttribute": { + "id": "endpoint_dataAttributes.createDataAttribute", + "description": "You can create a data attributes for a `contact` or a `company`.", + "namespace": [ + "Data Attributes" + ], + "displayName": "Create a data attribute", + "operationId": "createDataAttribute", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data_attributes" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_data_attribute_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_attribute" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Too few options for list", + "name": "Bad Request", + "examples": [ + { + "name": "Same name already exists", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "You already have 'The One Ring' in your company data. To save this as new people data, use a different name." + } + ] + } + } + }, + { + "name": "Invalid name", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Your name for this attribute must only contain alphanumeric characters, currency symbols, and hyphens" + } + ] + } + } + }, + { + "name": "Attribute already exists", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "You already have 'The One Ring' in your company data. To save this as new company data, use a different name." + } + ] + } + } + }, + { + "name": "Invalid Data Type", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Data Type isn't an option" + } + ] + } + } + }, + { + "name": "Too few options for list", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "The Data Attribute model field must be either contact or company" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/data_attributes", + "responseStatusCode": 200, + "name": "Successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": 37, + "type": "data_attribute", + "name": "Mithril Shirt", + "full_name": "custom_attributes.Mithril Shirt", + "label": "Mithril Shirt", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": false, + "custom": true, + "archived": false, + "admin_id": "991267686", + "created_at": 1719492955, + "updated_at": 1719492955, + "model": "company" + } + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_dataAttributes.updateDataAttribute": { + "id": "endpoint_dataAttributes.updateDataAttribute", + "description": "\nYou can update a data attribute.\n\n> 🚧 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.\n", + "namespace": [ + "Data Attributes" + ], + "displayName": "Update a data attribute", + "operationId": "updateDataAttribute", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data_attributes" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The data attribute id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_data_attribute_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_attribute" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Too few options in list", + "name": "Bad Request", + "examples": [ + { + "name": "Too few options in list", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Options isn't an array" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Attribute Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Attribute Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "field_not_found", + "message": "We couldn't find that data attribute to update" + } + ] + } + } + } + ] + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Has Dependant Object", + "name": "Unprocessable Entity", + "examples": [ + { + "name": "Has Dependant Object", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "data_invalid", + "message": "The Data Attribute you are trying to archive has a dependant object" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/data_attributes/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": 44, + "type": "data_attribute", + "name": "The One Ring", + "full_name": "custom_attributes.The One Ring", + "label": "The One Ring", + "description": "Just a plain old ring", + "data_type": "string", + "options": [ + "1-10", + "11-20" + ], + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": true, + "archived": false, + "admin_id": "991267693", + "created_at": 1719492958, + "updated_at": 1719492959, + "model": "company" + } + } + }, + { + "path": "/data_attributes/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_dataEvents.lisDataEvents": { + "id": "endpoint_dataEvents.lisDataEvents", + "description": "\n> 🚧\n>\n> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days\n\nThe events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads)\n\nThe `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou can optionally define the result page size as well with the `per_page` parameter.\n", + "namespace": [ + "Data Events" + ], + "displayName": "List all data events", + "operationId": "lisDataEvents", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "events" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "filter", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The value must be user" + }, + { + "key": "summary", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "summary flag" + }, + { + "key": "filter", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + { + "key": "filter", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_event_summary" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/events", + "responseStatusCode": 200, + "name": "Successful response", + "queryParameters": { + "filter": { + "user_id": "string" + }, + "type": "string", + "summary": false + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "event.summary", + "events": [], + "pages": { + "next": "http://api.intercom.test/events?next page" + }, + "email": "user26@email.com", + "intercom_user_id": "667d61648a68186f43bafe4b", + "user_id": "test-uuid-replacement" + } + } + } + ] + }, + "endpoint_dataEvents.createDataEvent": { + "id": "endpoint_dataEvents.createDataEvent", + "description": "\nYou will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`.\n\nWhen using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.\n\nWith the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`).\n\n**NB: For the JSON object types, please note that we do not currently support nested JSON structure.**\n\n| Type | Description | Example |\n| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- |\n| String | The value is a JSON String | `\"source\":\"desktop\"` |\n| Number | The value is a JSON Number | `\"load\": 3.67` |\n| Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `\"contact_date\": 1392036272` |\n| Link | The value is a HTTP or HTTPS URI. | `\"article\": \"https://example.org/ab1de.html\"` |\n| Rich Link | The value is a JSON object that contains `url` and `value` keys. | `\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the dude abides\"}` |\n| Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `\"price\": {\"amount\": 34999, \"currency\": \"eur\"}` |\n\n**Lead Events**\n\nWhen submitting events for Leads, you will need to specify the Lead's `id`.\n\n**Metadata behaviour**\n\n- We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.\n- It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.\n- There might be up to 24 hrs delay when you send a new metadata for an existing event.\n\n**Event de-duplication**\n\nThe API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field.\n\nDuplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.\n\n### HTTP API Responses\n\n- Successful responses to submitted events return `202 Accepted` with an empty body.\n- Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code.\n- Events sent about users that cannot be found will return a `404 Not Found`.\n- Event lists containing duplicate events will have those duplicates ignored.\n- Server errors will return a `500` response code and may contain an error message in the body.\n\n", + "namespace": [ + "Data Events" + ], + "displayName": "Submit a data event", + "operationId": "createDataEvent", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "events" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_data_event_request" + } + } + } + ], + "responses": [], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [] + }, + "endpoint_dataEvents.dataEventSummaries": { + "id": "endpoint_dataEvents.dataEventSummaries", + "description": "Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.\n\n", + "namespace": [ + "Data Events" + ], + "displayName": "Create event summaries", + "operationId": "dataEventSummaries", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "events" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "summaries" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_data_event_summaries_request" + } + } + } + ], + "responses": [], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [] + }, + "endpoint_dataExport.createDataExport": { + "id": "endpoint_dataExport.createDataExport", + "description": "To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>🚧 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.\n\n>📘 Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.\n", + "namespace": [ + "Data Export" + ], + "displayName": "Create content data export", + "operationId": "createDataExport", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "export" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "content" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_data_exports_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_export" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/export/content/data", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "job_identifier": "bxe9awlish03jkq8", + "status": "pending", + "download_url": "", + "download_expires_at": "" + } + } + }, + { + "path": "/export/content/data", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "job_identifier": "bxe9awlish03jkq8", + "status": "pending", + "download_url": "", + "download_expires_at": "" + } + } + }, + { + "path": "/export/content/data", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_dataExport.getDataExport": { + "id": "endpoint_dataExport.getDataExport", + "description": "You can view the status of your job by sending a `GET` request to the URL\n`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model.\n\n> 🚧 Jobs expire after two days\n> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.\n", + "namespace": [ + "Data Export" + ], + "displayName": "Show content data export", + "operationId": "getDataExport", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "export" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "content" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "job_identifier" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "job_identifier", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "job_identifier" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_export" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/export/content/data/{job_identifier}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "job_identifier": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "job_identifier": "b1ppo8h93fj386fk", + "status": "pending", + "download_url": "", + "download_expires_at": "" + } + } + } + ] + }, + "endpoint_dataExport.cancelDataExport": { + "id": "endpoint_dataExport.cancelDataExport", + "description": "You can cancel your job", + "namespace": [ + "Data Export" + ], + "displayName": "Cancel content data export", + "operationId": "cancelDataExport", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "export" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "cancel" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "job_identifier" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "job_identifier", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "job_identifier" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_export" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/export/cancel/{job_identifier}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "job_identifier": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "job_identifier": "pwrbmmimhakvlfsh", + "status": "canceled", + "download_url": "", + "download_expires_at": "" + } + } + } + ] + }, + "endpoint_dataExport.downloadDataExport": { + "id": "endpoint_dataExport.downloadDataExport", + "description": "When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message data will be streamed continuously back down to you in a gzipped CSV format.\n\n> 📘 Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n", + "namespace": [ + "Data Export" + ], + "displayName": "Download content data export", + "operationId": "downloadDataExport", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "download" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "content" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "job_identifier" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "job_identifier", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "job_identifier" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [], + "errors": [], + "examples": [] + }, + "endpoint_messages.createMessage": { + "id": "endpoint_messages.createMessage", + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\n\n> 🚧 Sending for visitors\n>\n> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.\n\nThis will return the Message model that has been created.\n\n> 🚧 Retrieving Associated Conversations\n>\n> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.\n", + "namespace": [ + "Messages" + ], + "displayName": "Create a message", + "operationId": "createMessage", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "messages" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_message_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "message" + } + }, + "description": "admin message created" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "No body supplied for email message", + "name": "Bad Request", + "examples": [ + { + "name": "No body supplied for message", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Body is required" + } + ] + } + } + }, + { + "name": "No body supplied for email message", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Body is required" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "No subject supplied for email message", + "name": "Unprocessable Entity", + "examples": [ + { + "name": "No subject supplied for email message", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_not_found", + "message": "No subject supplied for email message" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/messages", + "responseStatusCode": 200, + "name": "user message created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "user_message", + "id": "403918316", + "created_at": 1719492969, + "body": "heyy", + "message_type": "inapp", + "conversation_id": "476" + } + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "name": "lead message created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "user_message", + "id": "403918317", + "created_at": 1719492971, + "body": "heyy", + "message_type": "inapp", + "conversation_id": "477" + } + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "name": "admin message created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "admin_message", + "id": "15", + "created_at": 1719492972, + "subject": "heyy", + "body": "heyy", + "message_type": "inapp", + "owner": { + "type": "admin", + "id": "991267716", + "name": "Ciaran269 Lee", + "email": "admin269@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + } + } + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_news.listNewsItems": { + "id": "endpoint_news.listNewsItems", + "description": "You can fetch a list of all news items", + "namespace": [ + "News" + ], + "displayName": "List all news items", + "operationId": "listNewsItems", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news_items" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "paginated_response" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/news_items", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "pages": { + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages" + }, + "data": [ + { + "id": "29", + "type": "news-item", + "workspace_id": "this_is_an_id494_that_should_be_at_least_", + "title": "We have news", + "body": "

Hello there,

", + "sender_id": 991267725, + "state": "draft", + "labels": [], + "cover_image_url": null, + "reactions": [ + null, + null, + null, + null + ], + "deliver_silently": false, + "created_at": 1719492976, + "updated_at": 1719492976, + "newsfeed_assignments": [] + }, + { + "id": "30", + "type": "news-item", + "workspace_id": "this_is_an_id494_that_should_be_at_least_", + "title": "We have news", + "body": "

Hello there,

", + "sender_id": 991267727, + "state": "draft", + "labels": [], + "cover_image_url": null, + "reactions": [ + null, + null, + null, + null + ], + "deliver_silently": false, + "created_at": 1719492976, + "updated_at": 1719492976, + "newsfeed_assignments": [] + } + ], + "total_count": 2 + } + } + } + ] + }, + "endpoint_news.createNewsItem": { + "id": "endpoint_news.createNewsItem", + "description": "You can create a news item", + "namespace": [ + "News" + ], + "displayName": "Create a news item", + "operationId": "createNewsItem", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news_items" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "news_item_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "news_item" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/news_items", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "33", + "type": "news-item", + "workspace_id": "this_is_an_id498_that_should_be_at_least_", + "title": "Halloween is here!", + "body": "

New costumes in store for this spooky season

", + "sender_id": 991267734, + "state": "live", + "labels": [ + "New", + "Product", + "Update" + ], + "cover_image_url": null, + "reactions": [ + "😆", + "😅" + ], + "deliver_silently": true, + "created_at": 1719492978, + "updated_at": 1719492978, + "newsfeed_assignments": [ + { + "newsfeed_id": 53, + "published_at": 1664638214 + } + ] + } + } + }, + { + "path": "/news/news_items", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "33", + "type": "news-item", + "workspace_id": "this_is_an_id498_that_should_be_at_least_", + "title": "Halloween is here!", + "body": "

New costumes in store for this spooky season

", + "sender_id": 991267734, + "state": "live", + "labels": [ + "New", + "Product", + "Update" + ], + "cover_image_url": null, + "reactions": [ + "😆", + "😅" + ], + "deliver_silently": true, + "created_at": 1719492978, + "updated_at": 1719492978, + "newsfeed_assignments": [ + { + "newsfeed_id": 53, + "published_at": 1664638214 + } + ] + } + } + }, + { + "path": "/news/news_items", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_news.retrieveNewsItem": { + "id": "endpoint_news.retrieveNewsItem", + "description": "You can fetch the details of a single news item.", + "namespace": [ + "News" + ], + "displayName": "Retrieve a news item", + "operationId": "retrieveNewsItem", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news_items" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the news item which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "news_item" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "News Item Not Found", + "name": "Not Found", + "examples": [ + { + "name": "News Item Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "34", + "type": "news-item", + "workspace_id": "this_is_an_id502_that_should_be_at_least_", + "title": "We have news", + "body": "

Hello there,

", + "sender_id": 991267737, + "state": "live", + "labels": [], + "cover_image_url": null, + "reactions": [ + null, + null, + null, + null + ], + "deliver_silently": false, + "created_at": 1719492979, + "updated_at": 1719492979, + "newsfeed_assignments": [ + { + "newsfeed_id": 55, + "published_at": 1719492980 + } + ] + } + } + } + ] + }, + "endpoint_news.updateNewsItem": { + "id": "endpoint_news.updateNewsItem", + "namespace": [ + "News" + ], + "displayName": "Update a news item", + "operationId": "updateNewsItem", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news_items" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the news item which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "news_item_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "news_item" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "News Item Not Found", + "name": "Not Found", + "examples": [ + { + "name": "News Item Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "37", + "type": "news-item", + "workspace_id": "this_is_an_id508_that_should_be_at_least_", + "title": "Christmas is here!", + "body": "

New gifts in store for the jolly season

", + "sender_id": 991267745, + "state": "live", + "labels": [], + "cover_image_url": null, + "reactions": [ + "😝", + "😂" + ], + "deliver_silently": false, + "created_at": 1719492982, + "updated_at": 1719492982, + "newsfeed_assignments": [] + } + } + }, + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "37", + "type": "news-item", + "workspace_id": "this_is_an_id508_that_should_be_at_least_", + "title": "Christmas is here!", + "body": "

New gifts in store for the jolly season

", + "sender_id": 991267745, + "state": "live", + "labels": [], + "cover_image_url": null, + "reactions": [ + "😝", + "😂" + ], + "deliver_silently": false, + "created_at": 1719492982, + "updated_at": 1719492982, + "newsfeed_assignments": [] + } + } + }, + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_news.deleteNewsItem": { + "id": "endpoint_news.deleteNewsItem", + "description": "You can delete a single news item.", + "namespace": [ + "News" + ], + "displayName": "Delete a news item", + "operationId": "deleteNewsItem", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news_items" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the news item which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "deleted_object" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "News Item Not Found", + "name": "Not Found", + "examples": [ + { + "name": "News Item Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "40", + "object": "news-item", + "deleted": true + } + } + } + ] + }, + "endpoint_news.listLiveNewsfeedItems": { + "id": "endpoint_news.listLiveNewsfeedItems", + "description": "You can fetch a list of all news items that are live on a given newsfeed", + "namespace": [ + "News" + ], + "displayName": "List all live newsfeed items", + "operationId": "listLiveNewsfeedItems", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "newsfeeds" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "items" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the news feed item which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "paginated_response" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/newsfeeds/{id}/items", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "pages": { + "page": 1, + "per_page": 20, + "total_pages": 0, + "type": "pages" + }, + "data": [], + "total_count": 0 + } + } + } + ] + }, + "endpoint_news.listNewsfeeds": { + "id": "endpoint_news.listNewsfeeds", + "description": "You can fetch a list of all newsfeeds", + "namespace": [ + "News" + ], + "displayName": "List all newsfeeds", + "operationId": "listNewsfeeds", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "newsfeeds" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "paginated_response" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/newsfeeds", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "pages": { + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages" + }, + "data": [ + { + "id": "68", + "type": "newsfeed", + "name": "Visitor Feed", + "created_at": 1719492987, + "updated_at": 1719492987 + }, + { + "id": "69", + "type": "newsfeed", + "name": "Visitor Feed", + "created_at": 1719492987, + "updated_at": 1719492987 + } + ], + "total_count": 2 + } + } + } + ] + }, + "endpoint_news.retrieveNewsfeed": { + "id": "endpoint_news.retrieveNewsfeed", + "description": "You can fetch the details of a single newsfeed", + "namespace": [ + "News" + ], + "displayName": "Retrieve a newsfeed", + "operationId": "retrieveNewsfeed", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "newsfeeds" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the news feed item which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "newsfeed" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/newsfeeds/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "72", + "type": "newsfeed", + "name": "Visitor Feed", + "created_at": 1719492988, + "updated_at": 1719492988 + } + } + } + ] + }, + "endpoint_notes.retrieveNote": { + "id": "endpoint_notes.retrieveNote", + "description": "You can fetch the details of a single note.", + "namespace": [ + "Notes" + ], + "displayName": "Retrieve a note", + "operationId": "retrieveNote", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "notes" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier of a given note" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "note" + } + }, + "description": "Note found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Note not found", + "name": "Not Found", + "examples": [ + { + "name": "Note not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/notes/{id}", + "responseStatusCode": 200, + "name": "Note found", + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "note", + "id": "37", + "created_at": 1718801789, + "contact": { + "type": "contact", + "id": "667d617d8a68186f43bafe58" + }, + "author": { + "type": "admin", + "id": "991267764", + "name": "Ciaran316 Lee", + "email": "admin316@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + } + } + } + ] + }, + "endpoint_segments.listSegments": { + "id": "endpoint_segments.listSegments", + "description": "You can fetch a list of all segments.", + "namespace": [ + "Segments" + ], + "displayName": "List all segments", + "operationId": "listSegments", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "segments" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "include_count", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "It includes the count of contacts that belong to each segment." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "segment_list" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/segments", + "responseStatusCode": 200, + "name": "Successful response", + "queryParameters": { + "include_count": true + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "segment.list", + "segments": [ + { + "type": "segment", + "id": "667d617f8a68186f43bafe5b", + "name": "John segment", + "created_at": 1719492991, + "updated_at": 1719492991, + "person_type": "user" + }, + { + "type": "segment", + "id": "667d617f8a68186f43bafe5c", + "name": "Jane segment", + "created_at": 1719492991, + "updated_at": 1719492991, + "person_type": "user" + } + ] + } + } + } + ] + }, + "endpoint_segments.retrieveSegment": { + "id": "endpoint_segments.retrieveSegment", + "description": "You can fetch the details of a single segment.", + "namespace": [ + "Segments" + ], + "displayName": "Retrieve a segment", + "operationId": "retrieveSegment", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "segments" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identified of a given segment." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "segment" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Segment not found", + "name": "Not Found", + "examples": [ + { + "name": "Segment not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/segments/{id}", + "responseStatusCode": 200, + "name": "Successful response", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "segment", + "id": "667d61808a68186f43bafe5f", + "name": "John segment", + "created_at": 1719492992, + "updated_at": 1719492992, + "person_type": "user" + } + } + } + ] + }, + "endpoint_subscriptionTypes.listSubscriptionTypes": { + "id": "endpoint_subscriptionTypes.listSubscriptionTypes", + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "namespace": [ + "Subscription Types" + ], + "displayName": "List subscription types", + "operationId": "listSubscriptionTypes", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "subscription_types" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "subscription_type_list" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/subscription_types", + "responseStatusCode": 200, + "name": "Successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "subscription", + "id": "137", + "state": "live", + "consent_type": "opt_out", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "email" + ] + } + ] + } + } + } + ] + }, + "endpoint_switch.createPhoneSwitch": { + "id": "endpoint_switch.createPhoneSwitch", + "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", + "namespace": [ + "Switch" + ], + "displayName": "Create a phone Switch", + "operationId": "createPhoneSwitch", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "phone_call_redirects" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_phone_switch_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "phone_switch" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "url": "http://via.intercom.io/msgr/6eb60123-dadb-4881-80fd-4fc2cf272b12", + "type": "phone_call_redirect" + } + } + }, + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "url": "http://via.intercom.io/msgr/6eb60123-dadb-4881-80fd-4fc2cf272b12", + "type": "phone_call_redirect" + } + } + }, + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tags.listTags": { + "id": "endpoint_tags.listTags", + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "namespace": [ + "Tags" + ], + "displayName": "List all tags", + "operationId": "listTags", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tags", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "tag", + "id": "115", + "name": "Manual tag 1" + } + ] + } + } + } + ] + }, + "endpoint_tags.createTag": { + "id": "endpoint_tags.createTag", + "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", + "namespace": [ + "Tags" + ], + "displayName": "Create or update a tag, Tag or untag companies, Tag contacts", + "operationId": "createTag", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "Action successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Invalid parameters", + "name": "Bad Request", + "examples": [ + { + "name": "Invalid parameters", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "invalid tag parameters" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "User not found", + "name": "Not Found", + "examples": [ + { + "name": "Company not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + }, + { + "name": "User not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tags", + "responseStatusCode": 200, + "name": "Action successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "118", + "name": "test" + } + } + }, + { + "path": "/tags", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "name": "test" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tags", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "test": "invalid" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tags", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "name": "test", + "companies": [ + { + "company_id": "123" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tags", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "name": "test", + "users": [ + { + "id": "123" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tags.findTag": { + "id": "endpoint_tags.findTag", + "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", + "namespace": [ + "Tags" + ], + "displayName": "Find a specific tag", + "operationId": "findTag", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier of a given tag" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "Tag found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag not found", + "name": "Not Found", + "examples": [ + { + "name": "Tag not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tags/{id}", + "responseStatusCode": 200, + "name": "Tag found", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "126", + "name": "Manual tag" + } + } + } + ] + }, + "endpoint_tags.deleteTag": { + "id": "endpoint_tags.deleteTag", + "description": "You can delete the details of tags that are on the workspace by passing in the id.", + "namespace": [ + "Tags" + ], + "displayName": "Delete tag", + "operationId": "deleteTag", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier of a given tag" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag has dependent objects", + "name": "Bad Request", + "examples": [ + { + "name": "Tag has dependent objects", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "tag_has_dependent_objects", + "message": "Unable to delete Tag with dependent objects. Segments: Seg 1." + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Resource not found", + "name": "Not Found", + "examples": [ + { + "name": "Resource not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [] + }, + "endpoint_teams.listTeams": { + "id": "endpoint_teams.listTeams", + "description": "This will return a list of team objects for the App.", + "namespace": [ + "Teams" + ], + "displayName": "List all teams", + "operationId": "listTeams", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "teams" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "team_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/teams", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "team.list", + "teams": [] + } + } + } + ] + }, + "endpoint_teams.retrieveTeam": { + "id": "endpoint_teams.retrieveTeam", + "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", + "namespace": [ + "Teams" + ], + "displayName": "Retrieve a team", + "operationId": "retrieveTeam", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "teams" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier of a given team." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "team" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Team not found", + "name": "Not Found", + "examples": [ + { + "name": "Team not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "team_not_found", + "message": "Team not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/teams/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "team", + "id": "991267802", + "name": "team 1", + "admin_ids": [] + } + } + } + ] + }, + "endpoint_ticketTypeAttributes.createTicketTypeAttribute": { + "id": "endpoint_ticketTypeAttributes.createTicketTypeAttribute", + "description": "You can create a new attribute for a ticket type.", + "namespace": [ + "Ticket Type Attributes" + ], + "displayName": "Create a new attribute for a ticket type", + "operationId": "createTicketTypeAttribute", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "ticket_type_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "attributes" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "ticket_type_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket type which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_ticket_type_attribute_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type_attribute" + } + }, + "description": "Ticket Type Attribute created" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types/{ticket_type_id}/attributes", + "responseStatusCode": 200, + "name": "Ticket Type Attribute created", + "pathParameters": { + "ticket_type_id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_type_attribute", + "id": "210", + "workspace_id": "this_is_an_id600_that_should_be_at_least_", + "name": "Attribute Title", + "description": "Attribute Description", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 2, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": false, + "ticket_type_id": 81, + "archived": false, + "created_at": 1719493013, + "updated_at": 1719493013 + } + } + }, + { + "path": "/ticket_types/{ticket_type_id}/attributes", + "responseStatusCode": 200, + "pathParameters": { + "ticket_type_id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_ticketTypeAttributes.updateTicketTypeAttribute": { + "id": "endpoint_ticketTypeAttributes.updateTicketTypeAttribute", + "description": "You can update an existing attribute for a ticket type.", + "namespace": [ + "Ticket Type Attributes" + ], + "displayName": "Update an existing attribute for a ticket type", + "operationId": "updateTicketTypeAttribute", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "ticket_type_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "attributes" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "ticket_type_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket type which is given by Intercom." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket type attribute which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_ticket_type_attribute_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type_attribute" + } + }, + "description": "Ticket Type Attribute updated" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types/{ticket_type_id}/attributes/{id}", + "responseStatusCode": 200, + "name": "Ticket Type Attribute updated", + "pathParameters": { + "ticket_type_id": "string", + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_type_attribute", + "id": "215", + "workspace_id": "this_is_an_id604_that_should_be_at_least_", + "name": "name", + "description": "New Attribute Description", + "data_type": "string", + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 83, + "archived": false, + "created_at": 1719493013, + "updated_at": 1719493014 + } + } + }, + { + "path": "/ticket_types/{ticket_type_id}/attributes/{id}", + "responseStatusCode": 200, + "pathParameters": { + "ticket_type_id": "string", + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_ticketTypes.listTicketTypes": { + "id": "endpoint_ticketTypes.listTicketTypes", + "description": "You can get a list of all ticket types for a workspace.", + "namespace": [ + "Ticket Types" + ], + "displayName": "List all ticket types", + "operationId": "listTicketTypes", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "ticket_type", + "id": "85", + "name": "Bug Report", + "description": "Bug Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "218", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 85, + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014 + }, + { + "type": "ticket_type_attribute", + "id": "220", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "name": "name", + "description": "description", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 85, + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014 + }, + { + "type": "ticket_type_attribute", + "id": "219", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 85, + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014 + } + ] + }, + "category": "Customer" + } + ] + } + } + } + ] + }, + "endpoint_ticketTypes.createTicketType": { + "id": "endpoint_ticketTypes.createTicketType", + "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "namespace": [ + "Ticket Types" + ], + "displayName": "Create a ticket type", + "operationId": "createTicketType", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_ticket_type_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type" + } + }, + "description": "Ticket type created" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types", + "responseStatusCode": 200, + "name": "Ticket type created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_type", + "id": "88", + "name": "Customer Issue", + "description": "Customer Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id612_that_should_be_at_least_", + "archived": false, + "created_at": 1719493016, + "updated_at": 1719493016, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "227", + "workspace_id": "this_is_an_id612_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 88, + "archived": false, + "created_at": 1719493016, + "updated_at": 1719493016 + }, + { + "type": "ticket_type_attribute", + "id": "228", + "workspace_id": "this_is_an_id612_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 88, + "archived": false, + "created_at": 1719493016, + "updated_at": 1719493016 + } + ] + }, + "category": "Customer" + } + } + }, + { + "path": "/ticket_types", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_ticketTypes.getTicketType": { + "id": "endpoint_ticketTypes.getTicketType", + "description": "You can fetch the details of a single ticket type.", + "namespace": [ + "Ticket Types" + ], + "displayName": "Retrieve a ticket type", + "operationId": "getTicketType", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket type which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type" + } + }, + "description": "Ticket type found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types/{id}", + "responseStatusCode": 200, + "name": "Ticket type found", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_type", + "id": "90", + "name": "Bug Report", + "description": "Bug Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "232", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 90, + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017 + }, + { + "type": "ticket_type_attribute", + "id": "234", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "name": "name", + "description": "description", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 90, + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017 + }, + { + "type": "ticket_type_attribute", + "id": "233", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 90, + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017 + } + ] + }, + "category": "Customer" + } + } + } + ] + }, + "endpoint_ticketTypes.updateTicketType": { + "id": "endpoint_ticketTypes.updateTicketType", + "description": "\nYou can update a ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "namespace": [ + "Ticket Types" + ], + "displayName": "Update a ticket type", + "operationId": "updateTicketType", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket type which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_ticket_type_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type" + } + }, + "description": "Ticket type updated" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types/{id}", + "responseStatusCode": 200, + "name": "Ticket type updated", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_type", + "id": "92", + "name": "Bug Report 2", + "description": "Bug Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "238", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 92, + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018 + }, + { + "type": "ticket_type_attribute", + "id": "240", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "name": "name", + "description": "description", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 92, + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018 + }, + { + "type": "ticket_type_attribute", + "id": "239", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 92, + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018 + } + ] + }, + "category": "Customer" + } + } + }, + { + "path": "/ticket_types/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tickets.replyTicket": { + "id": "endpoint_tickets.replyTicket", + "description": "You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.", + "namespace": [ + "Tickets" + ], + "displayName": "Reply to a ticket", + "operationId": "replyTicket", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "reply" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_reply" + } + }, + "description": "Admin quick_reply reply" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "User reply", + "name": "Bad Request", + "examples": [ + { + "name": "User reply", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_mismatch", + "message": "User replies are not allowed on Backoffice tickets" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "name": "Admin note reply", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_part", + "id": "122", + "part_type": "note", + "body": "

An Unordered HTML List

\n
    \n
  • Coffee
    • \n
  • Tea
    • \n
  • Milk
    • \n
\n

An Ordered HTML List

\n
    \n
  1. Coffee
    2. \n
  2. Tea
    3. \n
  3. Milk
    4. \n
", + "created_at": 1719493024, + "updated_at": 1719493024, + "author": { + "id": "991267829", + "type": "admin", + "name": "Ciaran375 Lee", + "email": "admin375@email.com" + }, + "attachments": [], + "redacted": false + } + } + }, + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "name": "Admin quick_reply reply", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_part", + "id": "124", + "part_type": "quick_reply", + "created_at": 1719493029, + "updated_at": 1719493029, + "author": { + "id": "991267834", + "type": "admin", + "name": "Ciaran379 Lee", + "email": "admin379@email.com" + }, + "attachments": [], + "redacted": false + } + } + }, + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "comment", + "type": "user", + "intercom_user_id": "667d619d8a68186f43bafe82", + "body": "Thanks again :)" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "note", + "type": "admin", + "admin_id": 991267829, + "body": "

An Unordered HTML List

  • Coffee
  • Tea
  • Milk

An Ordered HTML List

  1. Coffee
  2. Tea
  3. Milk
" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "quick_reply", + "type": "admin", + "admin_id": 991267834, + "reply_options": [ + { + "text": "Yes", + "uuid": "test-uuid-replacement" + }, + { + "text": "No", + "uuid": "test-uuid-replacement" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "comment", + "type": "user", + "intercom_user_id": "667d61a68a68186f43bafe85", + "body": "Thanks again :)" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tagsTickets.attachTagToTicket": { + "id": "endpoint_tagsTickets.attachTagToTicket", + "description": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", + "namespace": [ + "Tags", + "Tickets" + ], + "displayName": "Add tag to a ticket", + "operationId": "attachTagToTicket", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "ticket_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "ticket_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ticket_id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the tag which is given by Intercom" + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the admin which is given by Intercom." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Ticket not found", + "name": "Not Found", + "examples": [ + { + "name": "Ticket not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "ticket_not_found", + "message": "Ticket not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets/{ticket_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "ticket_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "134", + "name": "Manual tag" + } + } + }, + { + "path": "/tickets/{ticket_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "ticket_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 134, + "admin_id": 991267844 + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "134", + "name": "Manual tag" + } + } + }, + { + "path": "/tickets/{ticket_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "ticket_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 134, + "admin_id": 991267844 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{ticket_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "ticket_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 135, + "admin_id": 991267847 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tagsTickets.detachTagFromTicket": { + "id": "endpoint_tagsTickets.detachTagFromTicket", + "description": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", + "namespace": [ + "Tags", + "Tickets" + ], + "displayName": "Remove tag from a ticket", + "operationId": "detachTagFromTicket", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "ticket_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "ticket_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ticket_id" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the tag which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the admin which is given by Intercom." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag not found", + "name": "Not Found", + "examples": [ + { + "name": "Ticket not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "ticket_not_found", + "message": "Ticket not found" + } + ] + } + } + }, + { + "name": "Tag not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "tag_not_found", + "message": "Tag not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets/{ticket_id}/tags/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "ticket_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "137", + "name": "Manual tag" + } + } + }, + { + "path": "/tickets/{ticket_id}/tags/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "ticket_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267853 + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "137", + "name": "Manual tag" + } + } + }, + { + "path": "/tickets/{ticket_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "ticket_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267853 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{ticket_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "ticket_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267856 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{ticket_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "ticket_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267859 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tickets.createTicket": { + "id": "endpoint_tickets.createTicket", + "description": "You can create a new ticket.", + "namespace": [ + "Tickets" + ], + "displayName": "Create a ticket", + "operationId": "createTicket", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_ticket_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets", + "responseStatusCode": 200, + "name": "Successful response", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket", + "id": "489", + "ticket_id": "48", + "ticket_attributes": { + "_default_title_": "example", + "_default_description_": "there is a problem" + }, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "106", + "name": "my-ticket-type-15", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id648_that_should_be_at_least_", + "archived": false, + "created_at": 1719493047, + "updated_at": 1719493047, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "252", + "workspace_id": "this_is_an_id648_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 106, + "archived": false, + "created_at": 1719493047, + "updated_at": 1719493047 + }, + { + "type": "ticket_type_attribute", + "id": "253", + "workspace_id": "this_is_an_id648_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 106, + "archived": false, + "created_at": 1719493047, + "updated_at": 1719493047 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61b78a68186f43bafe8d", + "external_id": "70" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719493048, + "updated_at": 1719493048, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "125", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493048, + "updated_at": 1719493048, + "author": { + "id": "991267871", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id648_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 1 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + } + }, + { + "path": "/tickets", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tickets.getTicket": { + "id": "endpoint_tickets.getTicket", + "description": "You can fetch the details of a single ticket.", + "namespace": [ + "Tickets" + ], + "displayName": "Retrieve a ticket", + "operationId": "getTicket", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket" + } + }, + "description": "Ticket found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets/{id}", + "responseStatusCode": 200, + "name": "Ticket found", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket", + "id": "493", + "ticket_id": "52", + "ticket_attributes": { + "_default_title_": "attribute_value", + "_default_description_": null + }, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "112", + "name": "my-ticket-type-21", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id660_that_should_be_at_least_", + "archived": false, + "created_at": 1719493060, + "updated_at": 1719493060, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "268", + "workspace_id": "this_is_an_id660_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 112, + "archived": false, + "created_at": 1719493060, + "updated_at": 1719493060 + }, + { + "type": "ticket_type_attribute", + "id": "269", + "workspace_id": "this_is_an_id660_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 112, + "archived": false, + "created_at": 1719493060, + "updated_at": 1719493060 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61c48a68186f43bafe91", + "external_id": "test-uuid-replacement" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719493061, + "updated_at": 1719493061, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "134", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493061, + "updated_at": 1719493061, + "author": { + "id": "991267912", + "type": "admin", + "name": "Ciaran445 Lee", + "email": "admin445@email.com" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 1 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + } + } + ] + }, + "endpoint_tickets.updateTicket": { + "id": "endpoint_tickets.updateTicket", + "description": "You can update a ticket.", + "namespace": [ + "Tickets" + ], + "displayName": "Update a ticket", + "operationId": "updateTicket", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_ticket_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets/{id}", + "responseStatusCode": 200, + "name": "Successful response", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket", + "id": "490", + "ticket_id": "49", + "ticket_attributes": { + "_default_title_": "example", + "_default_description_": "there is a problem" + }, + "ticket_state": "in_progress", + "ticket_type": { + "type": "ticket_type", + "id": "108", + "name": "my-ticket-type-17", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + "archived": false, + "created_at": 1719493050, + "updated_at": 1719493050, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "257", + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 108, + "archived": false, + "created_at": 1719493050, + "updated_at": 1719493050 + }, + { + "type": "ticket_type_attribute", + "id": "258", + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 108, + "archived": false, + "created_at": 1719493050, + "updated_at": 1719493050 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61bb8a68186f43bafe8e", + "external_id": "test-uuid-replacement" + } + ] + }, + "admin_assignee_id": "991267885", + "team_assignee_id": "0", + "created_at": 1719493051, + "updated_at": 1719493054, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "126", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493051, + "updated_at": 1719493051, + "author": { + "id": "991267883", + "type": "admin", + "name": "Ciaran419 Lee", + "email": "admin419@email.com" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "127", + "part_type": "ticket_attribute_updated_by_admin", + "created_at": 1719493053, + "updated_at": 1719493053, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "128", + "part_type": "ticket_attribute_updated_by_admin", + "created_at": 1719493053, + "updated_at": 1719493053, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "129", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "in_progress", + "previous_ticket_state": "submitted", + "created_at": 1719493053, + "updated_at": 1719493053, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "130", + "part_type": "assignment", + "created_at": 1719493054, + "updated_at": 1719493054, + "assigned_to": { + "type": "admin", + "id": "991267885" + }, + "author": { + "id": "991267883", + "type": "admin", + "name": "Ciaran419 Lee", + "email": "admin419@email.com" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "131", + "part_type": "snoozed", + "created_at": 1719493054, + "updated_at": 1719493054, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 6 + }, + "open": true, + "snoozed_until": 1719590400, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "In progress", + "ticket_state_external_label": "In progress" + } + } + }, + { + "path": "/tickets/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tickets.searchTickets": { + "id": "endpoint_tickets.searchTickets", + "description": "You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`.\n\nThis will accept a query object in the body which will define your filters.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiples there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foobar\"`).\n\n| Field | Type |\n| :---------------------------------------- | :--------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| _default_title_ | String |\n| _default_description_ | String |\n| category | String |\n| ticket_type_id | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | String |\n| team_assignee_id | String |\n| open | Boolean |\n| state | String |\n| snoozed_until | Date (UNIX timestamp) |\n| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |\n\n### Accepted Operators\n\n{% admonition type=\"info\" name=\"Searching based on `created_at`\" %}\n You may use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "namespace": [ + "Tickets" + ], + "displayName": "Search tickets", + "operationId": "searchTickets", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "search" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "search_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_list" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/tickets/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 1 + }, + "total_count": 1, + "tickets": [ + { + "type": "ticket", + "id": "494", + "ticket_id": "53", + "ticket_attributes": { + "_default_title_": "attribute_value", + "_default_description_": null + }, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "117", + "name": "my-ticket-type-26", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "279", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 117, + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065 + }, + { + "type": "ticket_type_attribute", + "id": "280", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 117, + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61c98a68186f43bafe92", + "external_id": "test-uuid-replacement" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719493065, + "updated_at": 1719493066, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "135", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493066, + "updated_at": 1719493066, + "author": { + "id": "991267940", + "type": "admin", + "name": "Ciaran472 Lee", + "email": "admin472@email.com" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 1 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + ] + } + } + }, + { + "path": "/tickets/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 1 + }, + "total_count": 1, + "tickets": [ + { + "type": "ticket", + "id": "494", + "ticket_id": "53", + "ticket_attributes": { + "_default_title_": "attribute_value", + "_default_description_": null + }, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "117", + "name": "my-ticket-type-26", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "279", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 117, + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065 + }, + { + "type": "ticket_type_attribute", + "id": "280", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 117, + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61c98a68186f43bafe92", + "external_id": "test-uuid-replacement" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719493065, + "updated_at": 1719493066, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "135", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493066, + "updated_at": 1719493066, + "author": { + "id": "991267940", + "type": "admin", + "name": "Ciaran472 Lee", + "email": "admin472@email.com" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 1 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + ] + } + } + }, + { + "path": "/tickets/search", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_visitors.retrieveVisitorWithUserId": { + "id": "endpoint_visitors.retrieveVisitorWithUserId", + "description": "You can fetch the details of a single visitor.", + "namespace": [ + "Visitors" + ], + "displayName": "Retrieve a visitor with User ID", + "operationId": "retrieveVisitorWithUserId", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "visitors" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The user_id of the Visitor you want to retrieve." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "visitor" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Visitor not found", + "name": "Not Found", + "examples": [ + { + "name": "Visitor not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Visitor Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/visitors", + "responseStatusCode": 200, + "name": "successful", + "queryParameters": { + "user_id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "visitor", + "id": "667d61ce8a68186f43bafe9b", + "user_id": "test-uuid-replacement", + "anonymous": true, + "email": "", + "phone": null, + "name": null, + "pseudonym": null, + "avatar": { + "type": "avatar", + "image_url": null + }, + "app_id": "this_is_an_id677_that_should_be_at_least_", + "companies": { + "type": "company.list", + "companies": [] + }, + "location_data": {}, + "last_request_at": null, + "created_at": 1719493070, + "remote_created_at": 1719493070, + "signed_up_at": 1719493070, + "updated_at": 1719493070, + "session_count": 0, + "social_profiles": { + "type": "social_profile.list", + "social_profiles": [] + }, + "owner_id": null, + "unsubscribed_from_emails": false, + "marked_email_as_spam": false, + "has_hard_bounced": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "custom_attributes": {}, + "referrer": null, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "do_not_track": null + } + } + } + ] + }, + "endpoint_visitors.updateVisitor": { + "id": "endpoint_visitors.updateVisitor", + "description": "Sending a PUT request to `/visitors` will result in an update of an existing Visitor.\n\n**Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body.\n\n**Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body.\n", + "namespace": [ + "Visitors" + ], + "displayName": "Update a visitor", + "operationId": "updateVisitor", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "visitors" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_visitor_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "visitor" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "visitor Not Found", + "name": "Not Found", + "examples": [ + { + "name": "visitor Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Visitor Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/visitors", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "visitor", + "id": "667d61cc8a68186f43bafe95", + "user_id": "test-uuid-replacement", + "anonymous": true, + "email": "", + "phone": null, + "name": "Gareth Bale", + "pseudonym": "Indigo Ghost", + "avatar": { + "type": "avatar", + "image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png" + }, + "app_id": "this_is_an_id671_that_should_be_at_least_", + "companies": { + "type": "company.list", + "companies": [] + }, + "location_data": {}, + "last_request_at": null, + "created_at": 1719493068, + "remote_created_at": 1719493068, + "signed_up_at": 1719493068, + "updated_at": 1719493068, + "session_count": 0, + "social_profiles": { + "type": "social_profile.list", + "social_profiles": [] + }, + "owner_id": null, + "unsubscribed_from_emails": false, + "marked_email_as_spam": false, + "has_hard_bounced": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "custom_attributes": {}, + "referrer": null, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "do_not_track": null + } + } + }, + { + "path": "/visitors", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "visitor", + "id": "667d61cc8a68186f43bafe95", + "user_id": "test-uuid-replacement", + "anonymous": true, + "email": "", + "phone": null, + "name": "Gareth Bale", + "pseudonym": "Indigo Ghost", + "avatar": { + "type": "avatar", + "image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png" + }, + "app_id": "this_is_an_id671_that_should_be_at_least_", + "companies": { + "type": "company.list", + "companies": [] + }, + "location_data": {}, + "last_request_at": null, + "created_at": 1719493068, + "remote_created_at": 1719493068, + "signed_up_at": 1719493068, + "updated_at": 1719493068, + "session_count": 0, + "social_profiles": { + "type": "social_profile.list", + "social_profiles": [] + }, + "owner_id": null, + "unsubscribed_from_emails": false, + "marked_email_as_spam": false, + "has_hard_bounced": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "custom_attributes": {}, + "referrer": null, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "do_not_track": null + } + } + }, + { + "path": "/visitors", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/visitors", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_visitors.convertVisitor": { + "id": "endpoint_visitors.convertVisitor", + "description": "You can merge a Visitor to a Contact of role type `lead` or `user`.\n\n> 📘 What happens upon a visitor being converted?\n>\n> If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers.\n", + "namespace": [ + "Visitors" + ], + "displayName": "Convert a visitor", + "operationId": "convertVisitor", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "visitors" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "convert" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "convert_visitor_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/visitors/convert", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d61d08a68186f43bafea2", + "workspace_id": "this_is_an_id683_that_should_be_at_least_", + "external_id": null, + "role": "user", + "email": "foo@bar.com", + "phone": null, + "name": null, + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719493072, + "updated_at": 1719493072, + "signed_up_at": 1719493072, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/visitors/convert", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d61d08a68186f43bafea2", + "workspace_id": "this_is_an_id683_that_should_be_at_least_", + "external_id": null, + "role": "user", + "email": "foo@bar.com", + "phone": null, + "name": null, + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719493072, + "updated_at": 1719493072, + "signed_up_at": 1719493072, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/visitors/convert", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "activity_log": { + "name": "Activity Log", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the activity." + }, + { + "key": "performed_by", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `admin`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the admin." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email of the admin." + }, + { + "key": "ip", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The IP address of the admin." + } + ] + }, + "description": "Details about the Admin involved in the activity." + }, + { + "key": "metadata", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "activity_log_metadata" + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the activity was created." + }, + { + "key": "activity_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin_assignment_limit_change" + }, + { + "value": "admin_away_mode_change" + }, + { + "value": "admin_deletion" + }, + { + "value": "admin_deprovisioned" + }, + { + "value": "admin_impersonation_end" + }, + { + "value": "admin_impersonation_start" + }, + { + "value": "admin_invite_change" + }, + { + "value": "admin_invite_creation" + }, + { + "value": "admin_invite_deletion" + }, + { + "value": "admin_login_failure" + }, + { + "value": "admin_login_success" + }, + { + "value": "admin_logout" + }, + { + "value": "admin_password_reset_request" + }, + { + "value": "admin_password_reset_success" + }, + { + "value": "admin_permission_change" + }, + { + "value": "admin_provisioned" + }, + { + "value": "admin_two_factor_auth_change" + }, + { + "value": "admin_unauthorized_sign_in_method" + }, + { + "value": "app_admin_join" + }, + { + "value": "app_authentication_method_change" + }, + { + "value": "app_data_deletion" + }, + { + "value": "app_data_export" + }, + { + "value": "app_google_sso_domain_change" + }, + { + "value": "app_identity_verification_change" + }, + { + "value": "app_name_change" + }, + { + "value": "app_outbound_address_change" + }, + { + "value": "app_package_installation" + }, + { + "value": "app_package_token_regeneration" + }, + { + "value": "app_package_uninstallation" + }, + { + "value": "app_team_creation" + }, + { + "value": "app_team_deletion" + }, + { + "value": "app_team_membership_modification" + }, + { + "value": "app_timezone_change" + }, + { + "value": "app_webhook_creation" + }, + { + "value": "app_webhook_deletion" + }, + { + "value": "articles_in_messenger_enabled_change" + }, + { + "value": "bulk_delete" + }, + { + "value": "bulk_export" + }, + { + "value": "campaign_deletion" + }, + { + "value": "campaign_state_change" + }, + { + "value": "conversation_part_deletion" + }, + { + "value": "conversation_topic_change" + }, + { + "value": "conversation_topic_creation" + }, + { + "value": "conversation_topic_deletion" + }, + { + "value": "help_center_settings_change" + }, + { + "value": "inbound_conversations_change" + }, + { + "value": "inbox_access_change" + }, + { + "value": "message_deletion" + }, + { + "value": "message_state_change" + }, + { + "value": "messenger_look_and_feel_change" + }, + { + "value": "messenger_search_required_change" + }, + { + "value": "messenger_spaces_change" + }, + { + "value": "office_hours_change" + }, + { + "value": "role_change" + }, + { + "value": "role_creation" + }, + { + "value": "role_deletion" + }, + { + "value": "ruleset_activation_title_preview" + }, + { + "value": "ruleset_creation" + }, + { + "value": "ruleset_deletion" + }, + { + "value": "search_browse_enabled_change" + }, + { + "value": "search_browse_required_change" + }, + { + "value": "seat_change" + }, + { + "value": "seat_revoke" + }, + { + "value": "security_settings_change" + }, + { + "value": "temporary_expectation_change" + }, + { + "value": "upfront_email_collection_change" + }, + { + "value": "welcome_message_change" + } + ] + } + }, + { + "key": "activity_description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A sentence or two describing the activity." + } + ] + } + } + }, + "description": "Activities performed by Admins." + }, + "activity_log_list": { + "name": "Paginated Response", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `activity_log.list`." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "activity_logs", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "activity_log" + } + } + } + }, + "description": "An array of activity logs" + } + ] + }, + "description": "A paginated list of activity logs." + }, + "activity_log_metadata": { + "name": "Activity Log Metadata", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "sign_in_method", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The way the admin signed in." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + }, + { + "key": "away_mode", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "The away mode status which is set to true when away and false when returned." + }, + { + "key": "away_status_reason", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The reason the Admin is away." + }, + { + "key": "reassign_conversations", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Indicates if conversations should be reassigned while an Admin is away." + }, + { + "key": "source", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The action that initiated the status change." + }, + { + "key": "auto_changed", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Indicates if the status was changed automatically or manually." + }, + { + "key": "update_by", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The ID of the Admin who initiated the activity." + }, + { + "key": "update_by_name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the Admin who initiated the activity." + } + ] + } + } + }, + "description": "Additional data provided about Admin activity." + }, + "addressable_list": { + "name": "Addressable List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "The addressable object type" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the addressable object" + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "Url to get more company resources for this contact" + } + ] + }, + "description": "A list used to access other resources from a parent model." + }, + "admin": { + "name": "Admin", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `admin`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the admin." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the admin." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email of the admin." + }, + { + "key": "job_title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The job title of the admin." + }, + { + "key": "away_mode_enabled", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin is currently set in away mode." + }, + { + "key": "away_mode_reassign", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox." + }, + { + "key": "has_inbox_seat", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them." + }, + { + "key": "team_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "This object represents the avatar associated with the admin." + }, + { + "key": "avatar", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "Image for the associated team or teammate" + }, + { + "key": "team_priority_level", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "team_priority_level" + } + } + } + ] + } + } + }, + "description": "Admins are teammate accounts that have access to a workspace." + }, + "admin_list": { + "name": "Admins", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `admin.list`." + }, + { + "key": "admins", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "admin" + } + } + } + }, + "description": "A list of admins associated with a given workspace." + } + ] + }, + "description": "A list of admins associated with a given workspace." + }, + "admin_priority_level": { + "name": "Admin Priority Level", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "primary_admin_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The primary admin ids for the team" + }, + { + "key": "secondary_admin_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The secondary admin ids for the team" + } + ] + } + } + }, + "description": "Admin priority levels for the team" + }, + "admin_reply_conversation_request": { + "name": "Admin Reply", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "comment" + }, + { + "value": "note" + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin" + } + ] + } + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types." + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is authoring the comment." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time the reply was created. If not provided, the current time will be used." + }, + { + "key": "attachment_urls", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + } + } + }, + "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs." + }, + { + "key": "attachment_files", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_attachment_files" + } + } + } + } + } + }, + "description": "A list of files that will be added as attachments. You can include up to 10 files" + } + ] + }, + "description": "Payload of the request to reply on behalf of an admin" + }, + "admin_reply_ticket_request": { + "name": "Admin Reply on ticket", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "comment" + }, + { + "value": "note" + }, + { + "value": "quick_reply" + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin" + } + ] + } + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types." + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is authoring the comment." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time the reply was created. If not provided, the current time will be used." + }, + { + "key": "reply_options", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The text to display in this quick reply option." + }, + { + "key": "uuid", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + }, + "description": "A unique identifier for this quick reply option. This value will be available within the metadata of the comment ticket part that is created when a user clicks on this reply option." + } + ] + } + } + } + } + }, + "description": "The quick reply options to display. Must be present for quick_reply message types." + }, + { + "key": "attachment_urls", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + } + } + }, + "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs." + } + ] + }, + "description": "Payload of the request to reply on behalf of an admin" + }, + "admin_with_app": { + "name": "Admin", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `admin`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the admin." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the admin." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email of the admin." + }, + { + "key": "job_title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The job title of the admin." + }, + { + "key": "away_mode_enabled", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin is currently set in away mode." + }, + { + "key": "away_mode_reassign", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox." + }, + { + "key": "has_inbox_seat", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them." + }, + { + "key": "team_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "This is a list of ids of the teams that this admin is part of." + }, + { + "key": "avatar", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "avatar" + } + } + }, + "description": "This is a string that identifies the type of the object. It will always have the value `avatar`." + }, + { + "key": "image_url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "This object represents the avatar associated with the admin." + } + ] + }, + "description": "This object represents the avatar associated with the admin." + }, + { + "key": "email_verified", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Identifies if this admin's email is verified." + }, + { + "key": "app", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "app" + } + } + } + }, + "description": "App that the admin belongs to." + } + ] + } + } + }, + "description": "Admins are the teammate accounts that have access to a workspace" + }, + "ai_agent": { + "name": "AI Agent", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "essentials_plan_setup" + }, + { + "value": "profile" + }, + { + "value": "workflow" + }, + { + "value": "workflow_preview" + }, + { + "value": "fin_preview" + } + ] + }, + "description": "The type of the source that triggered AI Agent involvement in the conversation." + }, + { + "key": "source_title", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The title of the source that triggered AI Agent involvement in the conversation. If this is `essentials_plan_setup` then it will return `null`." + }, + { + "key": "last_answer_type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [] + } + } + }, + "description": "The type of the last answer delivered by AI Agent. If no answer was delivered then this will return `null`" + }, + { + "key": "resolution_state", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [ + { + "value": "assumed_resolution" + }, + { + "value": "confirmed_resolution" + }, + { + "value": "routed_to_team" + }, + { + "value": "abandoned" + } + ] + } + } + }, + "description": "The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return `null`." + }, + { + "key": "rating", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The customer satisfaction rating given to AI Agent, from 1-5." + }, + { + "key": "rating_remark", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The customer satisfaction rating remark given to AI Agent." + }, + { + "key": "content_sources", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "content_sources_list" + } + } + } + ] + }, + "description": "Data related to AI Agent involvement in the conversation." + }, + "app": { + "name": "App", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "app" + } + } + }, + "description": "" + }, + { + "key": "id_code", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the app." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the app." + }, + { + "key": "region", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom region the app is located in." + }, + { + "key": "timezone", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The timezone of the region where the app is located." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "When the app was created." + }, + { + "key": "identity_verification", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the app uses identity verification." + } + ] + } + } + }, + "description": "App is a workspace on Intercom" + }, + "article": { + "name": "Article", + "shape": { + "type": "object", + "extends": [ + "article_list_item" + ], + "properties": [ + { + "key": "statistics", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_statistics" + } + } + } + } + } + ] + }, + "description": "The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone." + }, + "article_content": { + "name": "Article Content", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [] + } + } + }, + "description": "The type of object - `article_content` ." + }, + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the article." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the article." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The body of the article." + }, + { + "key": "author_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The ID of the author of the article." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "published" + }, + { + "value": "draft" + } + ] + }, + "description": "Whether the article is `published` or is a `draft` ." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was created (seconds)." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was last updated (seconds)." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL of the article." + } + ] + } + } + }, + "description": "The Content of an Article." + }, + "article_list": { + "name": "Articles", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object - `list`." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of articles." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_list_item" + } + } + } + }, + "description": "An array of Article objects" + } + ] + }, + "description": "This will return a list of articles for the App." + }, + "article_list_item": { + "name": "Articles", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "article" + } + ], + "default": "article" + }, + "description": "The type of object - `article`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the article which is given by Intercom." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace which the article belongs to." + }, + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the article. For multilingual articles, this will be the title of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The description of the article. For multilingual articles, this will be the description of the default language's content." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The body of the article in HTML. For multilingual articles, this will be the body of the default language's content." + }, + { + "key": "author_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "published" + }, + { + "value": "draft" + } + ], + "default": "draft" + }, + "description": "Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The URL of the article. For multilingual articles, this will be the URL of the default language's content." + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of the article's parent collection or section. An article without this field stands alone." + }, + { + "key": "parent_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The ids of the article's parent collections or sections. An article without this field stands alone." + }, + { + "key": "parent_type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The type of parent, which can either be a `collection` or `section`." + }, + { + "key": "default_locale", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The default locale of the help center. This field is only returned for multilingual help centers." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_translated_content" + } + } + } + } + } + ] + }, + "description": "The data returned about your articles when you list them." + }, + "article_search_highlights": { + "name": "Article Search Highlights", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "article_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the corresponding article." + }, + { + "key": "highlighted_title", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "highlight" + }, + { + "value": "plain" + } + ] + }, + "description": "The type of text - `highlight` or `plain`." + }, + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The text of the title." + } + ] + } + } + }, + "description": "An Article title highlighted." + }, + { + "key": "highlighted_summary", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "highlight" + }, + { + "value": "plain" + } + ] + }, + "description": "The type of text - `highlight` or `plain`." + }, + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The text of the title." + } + ] + } + } + } + } + }, + "description": "An Article description and body text highlighted." + } + ] + }, + "description": "The highlighted results of an Article search. In the examples provided my search query is always \"my query\"." + }, + "article_search_response": { + "name": "Article Search Response", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object - `list`." + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of Articles matching the search query" + }, + { + "key": "data", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "articles", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article" + } + } + } + }, + "description": "An array of Article objects" + }, + { + "key": "highlights", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_search_highlights" + } + } + } + }, + "description": "A corresponding array of highlighted Article content" + } + ] + }, + "description": "An object containing the results of the search." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "The results of an Article search" + }, + "article_statistics": { + "name": "Article Statistics", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "article_statistics" + } + ], + "default": "article_statistics" + }, + "description": "The type of object - `article_statistics`." + }, + { + "key": "views", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of total views the article has received." + }, + { + "key": "conversions", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of conversations started from the article." + }, + { + "key": "reactions", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of total reactions the article has received." + }, + { + "key": "happy_reaction_percentage", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The percentage of happy reactions the article has received against other types of reaction." + }, + { + "key": "neutral_reaction_percentage", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The percentage of neutral reactions the article has received against other types of reaction." + }, + { + "key": "sad_reaction_percentage", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The percentage of sad reactions the article has received against other types of reaction." + } + ] + } + } + }, + "description": "The statistics of an article." + }, + "article_translated_content": { + "name": "Article Translated Content", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [] + } + } + }, + "description": "The type of object - article_translated_content." + }, + { + "key": "ar", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Arabic" + }, + { + "key": "bg", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Bulgarian" + }, + { + "key": "bs", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Bosnian" + }, + { + "key": "ca", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Catalan" + }, + { + "key": "cs", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Czech" + }, + { + "key": "da", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Danish" + }, + { + "key": "de", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in German" + }, + { + "key": "el", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Greek" + }, + { + "key": "en", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in English" + }, + { + "key": "es", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Spanish" + }, + { + "key": "et", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Estonian" + }, + { + "key": "fi", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Finnish" + }, + { + "key": "fr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in French" + }, + { + "key": "he", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Hebrew" + }, + { + "key": "hr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Croatian" + }, + { + "key": "hu", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Hungarian" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Indonesian" + }, + { + "key": "it", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Italian" + }, + { + "key": "ja", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Japanese" + }, + { + "key": "ko", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Korean" + }, + { + "key": "lt", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Lithuanian" + }, + { + "key": "lv", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Latvian" + }, + { + "key": "mn", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Mongolian" + }, + { + "key": "nb", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Norwegian" + }, + { + "key": "nl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Dutch" + }, + { + "key": "pl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Polish" + }, + { + "key": "pt", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Portuguese (Portugal)" + }, + { + "key": "ro", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Romanian" + }, + { + "key": "ru", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Russian" + }, + { + "key": "sl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Slovenian" + }, + { + "key": "sr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Serbian" + }, + { + "key": "sv", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Swedish" + }, + { + "key": "tr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Turkish" + }, + { + "key": "vi", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Vietnamese" + }, + { + "key": "pt-BR", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Portuguese (Brazil)" + }, + { + "key": "zh-CN", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Chinese (China)" + }, + { + "key": "zh-TW", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Chinese (Taiwan)" + } + ] + } + } + }, + "description": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article." + }, + "assign_conversation_request": { + "name": "Assign Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "assignment" + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin" + }, + { + "value": "team" + } + ] + } + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is performing the action." + }, + { + "key": "assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The `id` of the `admin` or `team` which will be assigned the conversation. A conversation can be assigned both an admin and a team.\\nSet `0` if you want this assign to no admin or team (ie. Unassigned)." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Optionally you can send a response in the conversation when it is assigned." + } + ] + }, + "description": "Payload of the request to assign a conversation" + }, + "attach_contact_to_conversation_request": { + "name": "Assign Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The `id` of the admin who is adding the new participant." + }, + { + "key": "customer", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + }, + { + "key": "customer", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "customer_request" + } + } + } + } + } + ] + } + } + ] + }, + "description": "Payload of the request to assign a conversation" + }, + "close_conversation_request": { + "name": "Close Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "close" + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin" + } + ] + } + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is performing the action." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Optionally you can leave a message in the conversation to provide additional context to the user and other teammates." + } + ] + }, + "description": "Payload of the request to close a conversation" + }, + "collection": { + "name": "Collection", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the collection which is given by Intercom." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace which the collection belongs to." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The description of the collection. For multilingual help centers, this will be the description of the collection for the default language." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language." + }, + { + "key": "icon", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The icon of the collection." + }, + { + "key": "order", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order." + }, + { + "key": "default_locale", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The default locale of the help center. This field is only returned for multilingual help centers." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_translated_content" + } + } + } + } + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The id of the parent collection. If `null` then it is the first level collection." + }, + { + "key": "help_center_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of the help center the collection is in." + } + ] + }, + "description": "Collections are top level containers for Articles within the Help Center." + }, + "collection_list": { + "name": "Collections", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object - `list`." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of collections." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "collection" + } + } + } + }, + "description": "An array of collection objects" + } + ] + }, + "description": "This will return a list of Collections for the App." + }, + "company": { + "name": "Company", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "company" + } + ] + }, + "description": "Value is `company`" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the company." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the company." + }, + { + "key": "app_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined code of the workspace the company is associated to." + }, + { + "key": "plan", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Value is always \"plan\"" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the plan" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the plan" + } + ] + } + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The company id you have defined for the company." + }, + { + "key": "remote_created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the company was created by you." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the company was added in Intercom." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the company was updated." + }, + { + "key": "last_request_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the company last recorded making a request." + }, + { + "key": "size", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of employees in the company." + }, + { + "key": "website", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL for the company website." + }, + { + "key": "industry", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The industry that the company operates in." + }, + { + "key": "monthly_spend", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "How much revenue the company generates for your business." + }, + { + "key": "session_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "How many sessions the company has recorded." + }, + { + "key": "user_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of users in the company." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The custom attributes you have set on the company." + }, + { + "key": "tags", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "tag.list" + } + ] + }, + "description": "The type of the object" + } + ] + }, + "description": "The list of tags associated with the company" + }, + { + "key": "segments", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "segment.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "segments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "segment" + } + } + } + } + } + ] + }, + "description": "The list of segments associated with the company" + } + ] + }, + "description": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies." + }, + "company_attached_contacts": { + "name": "Company Attached Contacts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of object - `list`" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + } + } + }, + "description": "An array containing Contact Objects" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of contacts" + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "A list of Contact Objects" + }, + "company_attached_segments": { + "name": "Company Attached Segments", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of object - `list`" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "segment" + } + } + } + }, + "description": "An array containing Segment Objects" + } + ] + }, + "description": "A list of Segment Objects" + }, + "company_list": { + "name": "Companies", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of object - `list`." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of companies." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + } + } + }, + "description": "An array containing Company Objects." + } + ] + }, + "description": "This will return a list of companies for the App." + }, + "company_scroll": { + "name": "Company Scroll", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of object - `list`" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + } + } + } + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The total number of companies" + }, + { + "key": "scroll_param", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The scroll parameter to use in the next request to fetch the next page of results." + } + ] + } + } + }, + "description": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies." + }, + "contact": { + "name": "Contact", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of object." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace which the contact belongs to." + }, + { + "key": "role", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role of the contact." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The contact's email." + }, + { + "key": "email_domain", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The contact's email domain." + }, + { + "key": "phone", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The contacts phone." + }, + { + "key": "formatted_phone", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The contacts phone number normalized to the E164 format" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The contacts name." + }, + { + "key": "owner_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of an admin that has been assigned account ownership of the contact." + }, + { + "key": "has_hard_bounced", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact has had an email sent to them hard bounce." + }, + { + "key": "marked_email_as_spam", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact has marked an email sent to them as spam." + }, + { + "key": "unsubscribed_from_emails", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact is unsubscribed from emails." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "(UNIX timestamp) The time when the contact was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "(UNIX timestamp) The time when the contact was last updated." + }, + { + "key": "signed_up_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time specified for when a contact signed up." + }, + { + "key": "last_seen_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)." + }, + { + "key": "last_replied_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact last messaged in." + }, + { + "key": "last_contacted_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact was last messaged." + }, + { + "key": "last_email_opened_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact last opened an email." + }, + { + "key": "last_email_clicked_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact last clicked a link in an email." + }, + { + "key": "language_override", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change." + }, + { + "key": "browser", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the browser which the contact is using." + }, + { + "key": "browser_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the browser which the contact is using." + }, + { + "key": "browser_language", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The language set by the browser which the contact is using." + }, + { + "key": "os", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The operating system which the contact is using." + }, + { + "key": "android_app_name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the Android app which the contact is using." + }, + { + "key": "android_app_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the Android app which the contact is using." + }, + { + "key": "android_device", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The Android device which the contact is using." + }, + { + "key": "android_os_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the Android OS which the contact is using." + }, + { + "key": "android_sdk_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the Android SDK which the contact is using." + }, + { + "key": "android_last_seen_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact was last seen on an Android device." + }, + { + "key": "ios_app_name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the iOS app which the contact is using." + }, + { + "key": "ios_app_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the iOS app which the contact is using." + }, + { + "key": "ios_device", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The iOS device which the contact is using." + }, + { + "key": "ios_os_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of iOS which the contact is using." + }, + { + "key": "ios_sdk_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the iOS SDK which the contact is using." + }, + { + "key": "ios_last_seen_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The last time the contact used the iOS app." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "object", + "extends": [], + "properties": [] + }, + "description": "The custom attributes which are set for the contact." + }, + { + "key": "avatar", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of object" + }, + { + "key": "image_url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "An image URL containing the avatar of a contact." + } + ] + } + } + } + }, + { + "key": "tags", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_tags" + } + } + }, + { + "key": "notes", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_notes" + } + } + }, + { + "key": "companies", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_companies" + } + } + }, + { + "key": "location", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_location" + } + } + }, + { + "key": "social_profiles", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_social_profiles" + } + } + } + ] + }, + "description": "Contact are the objects that represent your leads and users in Intercom." + }, + "contact_archived": { + "name": "Contact Archived", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + } + ] + }, + "description": "always contact" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact is archived or not." + } + ] + }, + "description": "archived contact object" + }, + "contact_attached_companies": { + "name": "Contact Attached Companies", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of object" + }, + { + "key": "companies", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + } + } + }, + "description": "An array containing Company Objects" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of companies associated to this contact" + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "pages_link" + } + } + } + ] + }, + "description": "A list of Company Objects" + }, + "contact_companies": { + "name": "Contact companies", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "Url to get more company resources for this contact" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Int representing the total number of companyies attached to this contact" + }, + { + "key": "has_more", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all" + } + ] + }, + "description": "An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more." + }, + "contact_deleted": { + "name": "Contact Deleted", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + } + ] + }, + "description": "always contact" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + }, + { + "key": "deleted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact is deleted or not." + } + ] + }, + "description": "deleted contact object" + }, + "contact_list": { + "name": "Contact List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "Always list" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + } + } + }, + "description": "The list of contact objects" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of objects." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "Contacts are your users in Intercom." + }, + "contact_location": { + "name": "Contact Location", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Always location" + }, + { + "key": "country", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The country that the contact is located in" + }, + { + "key": "region", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The overal region that the contact is located in" + }, + { + "key": "city", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The city that the contact is located in" + } + ] + }, + "description": "An object containing location meta data about a Intercom contact." + }, + "contact_notes": { + "name": "Contact notes", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "addressable_list" + } + } + } + }, + "description": "This object represents the notes attached to a contact." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "Url to get more company resources for this contact" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Int representing the total number of companyies attached to this contact" + }, + { + "key": "has_more", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all" + } + ] + }, + "description": "An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more." + }, + "contact_reference": { + "name": "Contact Reference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + } + ] + }, + "description": "always contact" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + } + ] + }, + "description": "reference to contact object" + }, + "contact_reply_base_request": { + "name": "Contact Reply Base Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "comment" + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "user" + } + ] + } + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The text body of the comment." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time the reply was created. If not provided, the current time will be used." + }, + { + "key": "attachment_urls", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + } + } + }, + "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs." + } + ] + } + }, + "contact_reply_conversation_request": { + "name": "Contact Reply", + "shape": { + "type": "undiscriminatedUnion", + "variants": [] + } + }, + "contact_reply_email_request": { + "name": "Email", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email you have defined for the user." + }, + { + "key": "attachment_files", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_attachment_files" + } + } + } + } + } + }, + "description": "A list of files that will be added as attachments." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `email`" + }, + "contact_reply_intercom_user_id_request": { + "name": "Intercom User ID", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + }, + { + "key": "attachment_files", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_attachment_files" + } + } + } + } + } + }, + "description": "A list of files that will be added as attachments." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`" + }, + "contact_reply_ticket_email_request": { + "name": "Email", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email you have defined for the user." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `email`" + }, + "contact_reply_ticket_intercom_user_id_request": { + "name": "Intercom User ID", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`" + }, + "contact_reply_ticket_request": { + "name": "Contact Reply on ticket", + "shape": { + "type": "undiscriminatedUnion", + "variants": [] + } + }, + "contact_reply_ticket_user_id_request": { + "name": "User ID", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The external_id you have defined for the contact." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `user_id`" + }, + "contact_reply_user_id_request": { + "name": "User ID", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The external_id you have defined for the contact." + }, + { + "key": "attachment_files", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_attachment_files" + } + } + } + } + } + }, + "description": "A list of files that will be added as attachments. You can include up to 10 files." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `user_id`" + }, + "contact_segments": { + "name": "Segments", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "segment" + } + } + } + }, + "description": "Segment objects associated with the contact." + } + ] + }, + "description": "A list of segments objects attached to a specific contact." + }, + "contact_social_profiles": { + "name": "Social Profile", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "social_profile" + } + } + } + }, + "description": "A list of social profiles objects associated with the contact." + } + ] + }, + "description": "An object containing social profiles that a contact has." + }, + "contact_subscription_types": { + "name": "Contact Subscription Types", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "addressable_list" + } + } + } + }, + "description": "This object represents the subscriptions attached to a contact." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "Url to get more subscription type resources for this contact" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Int representing the total number of subscription types attached to this contact" + }, + { + "key": "has_more", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all" + } + ] + }, + "description": "An object containing Subscription Types meta data about the SubscriptionTypes that a contact has." + }, + "contact_tags": { + "name": "Contact Tags", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "addressable_list" + } + } + } + }, + "description": "This object represents the tags attached to a contact." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "url to get more tag resources for this contact" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Int representing the total number of tags attached to this contact" + }, + { + "key": "has_more", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all" + } + ] + } + } + }, + "description": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more." + }, + "contact_unarchived": { + "name": "Contact Unarchived", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + } + ] + }, + "description": "always contact" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact is archived or not." + } + ] + }, + "description": "unarchived contact object" + }, + "content_source": { + "name": "Content Source", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "file" + }, + { + "value": "article" + }, + { + "value": "external_content" + }, + { + "value": "content_snippet" + }, + { + "value": "workflow_connector_action" + } + ] + }, + "description": "The type of the content source." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The internal URL linking to the content source for teammates." + }, + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the content source." + }, + { + "key": "locale", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ISO 639 language code of the content source." + } + ] + }, + "description": "The content source used by AI Agent in the conversation." + }, + "content_sources_list": { + "name": "Content Source List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "content_source.list" + } + ] + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of content sources used by AI Agent in the conversation." + }, + { + "key": "content_sources", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "content_source" + } + } + } + }, + "description": "The content sources used by AI Agent in the conversation." + } + ] + } + }, + "conversation": { + "name": "Conversation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Always conversation." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the conversation." + }, + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The title given to the conversation." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the conversation was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the conversation was updated." + }, + { + "key": "waiting_since", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin." + }, + { + "key": "snoozed_until", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time." + }, + { + "key": "open", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether a conversation is open (true) or closed (false)." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "open" + }, + { + "value": "closed" + }, + { + "value": "snoozed" + } + ] + }, + "description": "Can be set to \"open\", \"closed\" or \"snoozed\"." + }, + { + "key": "read", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether a conversation has been read." + }, + { + "key": "priority", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "priority" + }, + { + "value": "not_priority" + } + ] + }, + "description": "If marked as priority, it will return priority or else not_priority." + }, + { + "key": "admin_assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null." + }, + { + "key": "team_assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The id of the team assigned to the conversation. If it's not assigned to a team it will return null." + }, + { + "key": "tags", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "tags" + } + } + }, + { + "key": "conversation_rating", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_rating" + } + } + }, + { + "key": "source", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_source" + } + } + }, + { + "key": "contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_contacts" + } + } + }, + { + "key": "teammates", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_teammates" + } + } + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "custom_attributes" + } + } + }, + { + "key": "first_contact_reply", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_first_contact_reply" + } + } + }, + { + "key": "sla_applied", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "sla_applied" + } + } + }, + { + "key": "statistics", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_statistics" + } + } + }, + { + "key": "conversation_parts", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_parts" + } + } + }, + { + "key": "linked_objects", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "linked_object_list" + } + } + }, + { + "key": "ai_agent_participated", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether the AI Agent participated in the conversation." + }, + { + "key": "ai_agent", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "ai_agent" + } + } + } + } + } + ] + }, + "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact." + }, + "conversation_attachment_files": { + "name": "Conversation attachment files", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The content type of the file" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The base64 encoded file data." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the file." + } + ] + }, + "description": "Properties of the attachment files in a conversation part" + }, + "conversation_contacts": { + "name": "Contacts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact.list" + } + ] + }, + "description": "" + }, + { + "key": "contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_reference" + } + } + } + }, + "description": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature." + } + ] + }, + "description": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature." + }, + "conversation_first_contact_reply": { + "name": "First contact reply", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "" + }, + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "" + } + ] + } + } + }, + "description": "An object containing information on the first users message. For a contact initiated message this will represent the users original message." + }, + "conversation_list": { + "name": "Conversation List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "conversation.list" + } + ] + }, + "description": "Always conversation.list" + }, + { + "key": "conversations", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + } + } + }, + "description": "The list of conversation objects" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of objects." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact." + }, + "conversation_part": { + "name": "Conversation Part", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Always conversation_part" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the conversation part." + }, + { + "key": "part_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of conversation part." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the conversation part was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the conversation part was updated." + }, + { + "key": "notified_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the user was notified with the conversation part." + }, + { + "key": "assigned_to", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "reference" + } + } + } + }, + "description": "The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)" + }, + { + "key": "author", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_part_author" + } + } + }, + { + "key": "attachments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "part_attachment" + } + } + } + }, + "description": "A list of attachments for the part." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The external id of the conversation part" + }, + { + "key": "redacted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the conversation part has been redacted." + } + ] + }, + "description": "A Conversation Part represents a message in the conversation." + }, + "conversation_part_author": { + "name": "Conversation part author", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the author" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the author" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the author" + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "email" + } + } + }, + "description": "The email of the author" + } + ] + }, + "description": "The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank." + }, + "conversation_parts": { + "name": "Conversation Parts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "conversation_part.list" + } + ] + }, + "description": "" + }, + { + "key": "conversation_parts", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_part" + } + } + } + }, + "description": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts." + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "" + } + ] + }, + "description": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts." + }, + "conversation_rating": { + "name": "Conversation Rating", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "rating", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The rating, between 1 and 5, for the conversation." + }, + { + "key": "remark", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An optional field to add a remark to correspond to the number rating" + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the rating was requested in the conversation being rated." + }, + { + "key": "contact", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_reference" + } + } + }, + { + "key": "teammate", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "reference" + } + } + } + ] + } + } + }, + "description": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation." + }, + "conversation_source": { + "name": "Conversation source", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the message." + }, + { + "key": "delivered_as", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email)." + }, + { + "key": "subject", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured." + }, + { + "key": "author", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_part_author" + } + } + }, + { + "key": "attachments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "part_attachment" + } + } + } + }, + "description": "A list of attachments for the part." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank." + }, + { + "key": "redacted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the source message has been redacted. Only applicable for contact initiated messages." + } + ] + }, + "description": "The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated." + }, + "conversation_statistics": { + "name": "Conversation statistics", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "time_to_assignment", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Duration until last assignment before first admin reply. In seconds." + }, + { + "key": "time_to_admin_reply", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Duration until first admin reply. Subtracts out of business hours. In seconds." + }, + { + "key": "time_to_first_close", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Duration until conversation was closed first time. Subtracts out of business hours. In seconds." + }, + { + "key": "time_to_last_close", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Duration until conversation was closed last time. Subtracts out of business hours. In seconds." + }, + { + "key": "median_time_to_reply", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds." + }, + { + "key": "first_contact_reply_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of first text conversation part from a contact." + }, + { + "key": "first_assignment_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of first assignment after first_contact_reply_at." + }, + { + "key": "first_admin_reply_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of first admin reply after first_contact_reply_at." + }, + { + "key": "first_close_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of first close after first_contact_reply_at." + }, + { + "key": "last_assignment_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of last assignment after first_contact_reply_at." + }, + { + "key": "last_assignment_admin_reply_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of first admin reply since most recent assignment." + }, + { + "key": "last_contact_reply_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of the last conversation part from a contact." + }, + { + "key": "last_admin_reply_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of the last conversation part from an admin." + }, + { + "key": "last_close_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of the last conversation close." + }, + { + "key": "last_closed_by_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The last admin who closed the conversation. Returns a reference to an Admin object." + }, + { + "key": "count_reopens", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of reopens after first_contact_reply_at." + }, + { + "key": "count_assignments", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of assignments after first_contact_reply_at." + }, + { + "key": "count_conversation_parts", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Total number of conversation parts." + } + ] + } + } + }, + "description": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics." + }, + "conversation_teammates": { + "name": "Conversation teammates", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the object - `admin.list`." + }, + { + "key": "teammates", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "reference" + } + } + } + }, + "description": "The list of teammates who participated in the conversation (wrote at least one conversation part)." + } + ] + } + } + }, + "description": "The list of teammates who participated in the conversation (wrote at least one conversation part)." + }, + "convert_conversation_to_ticket_request": { + "name": "Convert Ticket Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "ticket_type_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the type of ticket you want to convert the conversation to" + }, + { + "key": "attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_request_custom_attributes" + } + } + } + } + } + ] + }, + "description": "You can convert a Conversation to a Ticket" + }, + "convert_visitor_request": { + "name": "Convert Visitor Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Represents the role of the Contact model. Accepts `lead` or `user`." + } + ] + }, + "description": "You can merge a Visitor to a Contact of role type lead or user." + }, + "create_article_request": { + "name": "Create Article Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the article.For multilingual articles, this will be the title of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The description of the article. For multilingual articles, this will be the description of the default language's content." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The content of the article. For multilingual articles, this will be the body of the default language's content." + }, + { + "key": "author_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace." + }, + { + "key": "state", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "enum", + "values": [ + { + "value": "published" + }, + { + "value": "draft" + } + ] + } + } + }, + "description": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content." + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of the article's parent collection or section. An article without this field stands alone." + }, + { + "key": "parent_type", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The type of parent, which can either be a `collection` or `section`." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_translated_content" + } + } + } + } + } + ] + } + } + }, + "description": "You can create an Article" + }, + "create_collection_request": { + "name": "Create Collection Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The description of the collection. For multilingual collections, this will be the description of the default language's content." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_translated_content" + } + } + } + } + } + } + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "The id of the parent collection. If `null` then it will be created as the first level collection." + }, + { + "key": "help_center_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + } + } + }, + "description": "The id of the help center where the collection will be created. If `null` then it will be created in the default help center." + } + ] + }, + "description": "You can create a collection" + }, + "create_conversation_request": { + "name": "Create Conversation Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "from", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "lead" + }, + { + "value": "user" + }, + { + "value": "contact" + } + ] + }, + "description": "The role associated to the contact - user or lead." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid", + "minLength": 24, + "maxLength": 24 + } + } + }, + "description": "The identifier for the contact which is given by Intercom." + } + ] + } + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The content of the message. HTML is not supported." + } + ] + }, + "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact." + }, + "create_data_attribute_request": { + "name": "Create Data Attribute Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the data attribute." + }, + { + "key": "model", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + }, + { + "value": "company" + } + ] + }, + "description": "The model that the data attribute belongs to." + }, + { + "key": "data_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "string" + }, + { + "value": "integer" + }, + { + "value": "float" + }, + { + "value": "boolean" + }, + { + "value": "datetime" + }, + { + "value": "date" + } + ] + }, + "description": "The type of data stored for this attribute." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The readable description you see in the UI for the attribute." + }, + { + "key": "options", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "To create list attributes. Provide a set of hashes with `value` as the key of the options you want to make. `data_type` must be `string`." + }, + { + "key": "messenger_writable", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Can this attribute be updated by the Messenger" + } + ] + }, + "description": "" + }, + "create_data_event_summaries_request": { + "name": "Create Data Event Summaries Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your identifier for the user." + }, + { + "key": "event_summaries", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "event_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`." + }, + { + "key": "count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of times the event occurred." + }, + { + "key": "first", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the event was sent" + }, + { + "key": "last", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the event was sent" + } + ] + }, + "description": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`." + } + ] + }, + "description": "You can send a list of event summaries for a user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense \"verb-noun\" combination, to improve readability, for example `updated-plan`." + }, + "create_data_exports_request": { + "name": "Create Data Export Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at_after", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The start date that you request data for. It must be formatted as a unix timestamp." + }, + { + "key": "created_at_before", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The end date that you request data for. It must be formatted as a unix timestamp." + } + ] + }, + "description": "Request for creating a data export" + }, + "create_or_update_company_request": { + "name": "Create Or Update Company Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Company" + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The company id you have defined for the company. Can't be updated" + }, + { + "key": "plan", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the plan you have associated with the company." + }, + { + "key": "size", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of employees in this company." + }, + { + "key": "website", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL for this company's website. Please note that the value specified here is not validated. Accepts any string." + }, + { + "key": "industry", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The industry that this company operates in." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "A hash of key/value pairs containing any other data about the company you want Intercom to store." + }, + { + "key": "remote_created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the company was created by you." + }, + { + "key": "monthly_spend", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647.." + } + ] + } + } + }, + "description": "You can create or update a Company" + }, + "create_or_update_tag_request": { + "name": "Create or Update Tag Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The id of tag to updates." + } + ] + }, + "description": "You can create or update an existing tag." + }, + "create_phone_switch_request": { + "name": "Create Phone Switch Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "phone", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "custom_attributes" + } + } + } + } + } + ] + } + } + }, + "description": "You can create an phone switch" + }, + "create_ticket_reply_with_comment_request": { + "name": "Create Ticket Reply Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_reply_ticket_request" + } + } + }, + "create_ticket_request": { + "name": "Create Ticket Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "ticket_type_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the type of ticket you want to create" + }, + { + "key": "contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + } + ] + } + } + }, + "description": "The list of contacts (users or leads) affected by this ticket. Currently only one is allowed" + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The ID of the company that the ticket is associated with. The ID that you set upon company creation." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time the ticket was created. If not provided, the current time will be used." + }, + { + "key": "ticket_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_request_custom_attributes" + } + } + } + } + } + ] + }, + "description": "You can create a Ticket" + }, + "create_ticket_type_attribute_request": { + "name": "Create Ticket Type Attribute Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type attribute" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the attribute presented to the teammate or contact" + }, + { + "key": "data_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "string" + }, + { + "value": "list" + }, + { + "value": "integer" + }, + { + "value": "decimal" + }, + { + "value": "boolean" + }, + { + "value": "datetime" + }, + { + "value": "files" + } + ] + }, + "description": "The data type of the attribute" + }, + { + "key": "required_to_create", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + } + } + }, + "description": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox." + }, + { + "key": "required_to_create_for_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + } + } + }, + "description": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger." + }, + { + "key": "visible_on_create", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + } + } + }, + "description": "Whether the attribute is visible to teammates when creating a ticket in Inbox." + }, + { + "key": "visible_to_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + } + } + }, + "description": "Whether the attribute is visible to contacts when creating a ticket in Messenger." + }, + { + "key": "multiline", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Whether the attribute allows multiple lines of text (only applicable to string attributes)" + }, + { + "key": "list_items", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "A comma delimited list of items for the attribute value (only applicable to list attributes)" + }, + { + "key": "allow_multiple_values", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)" + } + ] + }, + "description": "You can create a Ticket Type Attribute" + }, + "create_ticket_type_request": { + "name": "Create Ticket Type Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The description of the ticket type." + }, + { + "key": "category", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "enum", + "values": [ + { + "value": "Customer" + }, + { + "value": "Back-office" + }, + { + "value": "Tracker" + } + ] + } + } + }, + "description": "Category of the Ticket Type." + }, + { + "key": "icon", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "🎟️" + } + } + } + } + }, + "description": "The icon of the ticket type." + }, + { + "key": "is_internal", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + } + } + }, + "description": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute." + } + ] + } + } + }, + "description": "The request payload for creating a ticket type.\n You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + }, + "cursor_pages": { + "name": "Cursor based pages", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "pages" + } + ] + }, + "description": "the type of object `pages`." + }, + { + "key": "page", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The current page" + }, + { + "key": "next", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "starting_after_paging" + } + } + }, + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of results per page" + }, + { + "key": "total_pages", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Total number of pages" + } + ] + } + } + }, + "description": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data.\nA \"cursor\" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or \"pages\" as needed.\n" + }, + "custom_attributes": { + "name": "Custom Attributes", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models." + }, + "custom_object_instance": { + "name": "Custom Object Instance", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the custom object instance." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id you have defined for the custom object instance." + }, + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier of the custom object type that defines the structure of the custom object instance." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The custom attributes you have set on the custom object instance." + } + ] + } + } + }, + "description": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes." + }, + "customer_request": { + "name": "customer_request", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + } + ] + } + } + } + }, + "data_attribute": { + "name": "Data Attribute", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "data_attribute" + } + ] + }, + "description": "Value is `data_attribute`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes." + }, + { + "key": "model", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + }, + { + "value": "company" + } + ] + }, + "description": "Value is `contact` for user/lead attributes and `company` for company attributes." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the attribute." + }, + { + "key": "full_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on `.` to access nested user object values." + }, + { + "key": "label", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Readable name of the attribute (i.e. name you see in the UI)" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Readable description of the attribute." + }, + { + "key": "data_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "string" + }, + { + "value": "integer" + }, + { + "value": "float" + }, + { + "value": "boolean" + }, + { + "value": "date" + } + ] + }, + "description": "The data type of the attribute." + }, + { + "key": "options", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "List of predefined options for attribute value." + }, + { + "key": "api_writable", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Can this attribute be updated through API" + }, + { + "key": "messenger_writable", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Can this attribute be updated by the Messenger" + }, + { + "key": "ui_writable", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Can this attribute be updated in the UI" + }, + { + "key": "custom", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Set to true if this is a CDA" + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Is this attribute archived. (Only applicable to CDAs)" + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the attribute was created as a UTC Unix timestamp" + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the attribute was last updated as a UTC Unix timestamp" + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Teammate who created the attribute. Only applicable to CDAs" + } + ] + }, + "description": "Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes." + }, + "data_attribute_list": { + "name": "Data Attribute List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "data_attribute" + } + } + } + }, + "description": "A list of data attributes" + } + ] + }, + "description": "A list of all data attributes belonging to a workspace for contacts, companies or conversations." + }, + "data_event": { + "name": "Data Event", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "enum", + "values": [ + { + "value": "event" + } + ] + } + } + }, + "description": "The type of the object" + }, + { + "key": "event_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the event occurred as a UTC Unix timestamp" + }, + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Your identifier for the user." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Your identifier for a lead or a user." + }, + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The Intercom identifier for the user." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "An email address for your user. An email should only be used where your application uses email to uniquely identify users." + }, + { + "key": "metadata", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Optional metadata about the event." + } + ] + }, + "description": "Data events are used to notify Intercom of changes to your data." + }, + "data_event_list": { + "name": "Data Event List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "event.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "events", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "data_event" + } + } + } + }, + "description": "A list of data events" + }, + { + "key": "pages", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "next", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "since", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + }, + "description": "Pagination" + } + ] + }, + "description": "This will return a list of data events for the App." + }, + "data_event_summary": { + "name": "Data Event Summary", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "event.summary" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email address of the user" + }, + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom user ID of the user" + }, + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The user ID of the user" + }, + { + "key": "events", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "data_event_summary_item" + } + } + } + }, + "description": "A summary of data events" + } + ] + }, + "description": "This will return a summary of data events for the App." + }, + "data_event_summary_item": { + "name": "Data Event Summary Item", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the event" + }, + { + "key": "first", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The first time the event was sent" + }, + { + "key": "last", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The last time the event was sent" + }, + { + "key": "count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of times the event was sent" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the event" + } + ] + } + } + }, + "description": "This will return a summary of a data event for the App." + }, + "data_export": { + "name": "Data Export", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_identfier", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for your job." + }, + { + "key": "status", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "pending" + }, + { + "value": "in_progress" + }, + { + "value": "failed" + }, + { + "value": "completed" + }, + { + "value": "no_data" + }, + { + "value": "canceled" + } + ] + }, + "description": "The current state of your job." + }, + { + "key": "download_expires_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The time after which you will not be able to access the data." + }, + { + "key": "download_url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The location where you can download your data." + } + ] + }, + "description": "The data export api is used to view all message sent & viewed in a given timeframe." + }, + "data_export_csv": { + "name": "Data Export CSV", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The user_id of the user who was sent the message." + }, + { + "key": "user_external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The external_user_id of the user who was sent the message" + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The company ID of the user in relation to the message that was sent. Will return -1 if no company is present." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The users email who was sent the message." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The full name of the user receiving the message" + }, + { + "key": "ruleset_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the message." + }, + { + "key": "content_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The specific content that was received. In an A/B test each version has its own Content ID." + }, + { + "key": "content_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Email, Chat, Post etc." + }, + { + "key": "content_title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the content you see in your Intercom workspace." + }, + { + "key": "ruleset_version_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received." + }, + { + "key": "receipt_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message." + }, + { + "key": "received_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Timestamp for when the receipt was recorded." + }, + { + "key": "series_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the series that this content is part of. Will return -1 if not part of a series." + }, + { + "key": "series_title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the series that this content is part of." + }, + { + "key": "node_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id." + }, + { + "key": "first_reply", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time a user replied to this message if the content was able to receive replies." + }, + { + "key": "first_completion", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys." + }, + { + "key": "first_series_completion", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the series this message was a part of was completed by the user." + }, + { + "key": "first_series_disengagement", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the series this message was a part of was disengaged by the user." + }, + { + "key": "first_series_exit", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the series this message was a part of was exited by the user." + }, + { + "key": "first_goal_success", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the user met this messages associated goal if one exists." + }, + { + "key": "first_open", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the user opened this message." + }, + { + "key": "first_click", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the series the user clicked on a link within this message." + }, + { + "key": "first_dismisall", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the series the user dismissed this message." + }, + { + "key": "first_unsubscribe", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the user unsubscribed from this message." + }, + { + "key": "first_hard_bounce", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time this message hard bounced for this user" + } + ] + }, + "description": "A CSV output file" + }, + "deleted_article_object": { + "name": "Deleted Article Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the article which you provided in the URL." + }, + { + "key": "object", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "article" + } + ] + }, + "description": "The type of object which was deleted. - article" + }, + { + "key": "deleted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the article was deleted successfully or not." + } + ] + }, + "description": "Response returned when an object is deleted" + }, + "deleted_collection_object": { + "name": "Deleted Collection Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the collection which you provided in the URL." + }, + { + "key": "object", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "collection" + } + ] + }, + "description": "The type of object which was deleted. - `collection`" + }, + { + "key": "deleted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the collection was deleted successfully or not." + } + ] + }, + "description": "Response returned when an object is deleted" + }, + "deleted_company_object": { + "name": "Deleted Company Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom." + }, + { + "key": "object", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "company" + } + ] + }, + "description": "The type of object which was deleted. - `company`" + }, + { + "key": "deleted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the company was deleted successfully or not." + } + ] + }, + "description": "Response returned when an object is deleted" + }, + "deleted_object": { + "name": "Deleted Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the news item which you provided in the URL." + }, + { + "key": "object", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "news-item" + } + ] + }, + "description": "The type of object which was deleted - news-item." + }, + { + "key": "deleted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the news item was deleted successfully or not." + } + ] + }, + "description": "Response returned when an object is deleted" + }, + "detach_contact_from_conversation_request": { + "name": "detach_contact_from_conversation_request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The `id` of the admin who is performing the action." + } + ] + } + }, + "error": { + "name": "Error", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type is error.list" + }, + { + "key": "request_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + } + } + } + }, + "description": "" + }, + { + "key": "errors", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "code", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A string indicating the kind of error, used to further qualify the HTTP response code" + }, + { + "key": "message", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Optional. Human readable description of the error." + }, + { + "key": "field", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Optional. Used to identify a particular field or query parameter that was in error." + } + ] + } + } + }, + "description": "An array of one or more error objects" + } + ] + }, + "description": "The API will return an Error List for a failed request, which will contain one or more Error objects." + }, + "file_attribute": { + "name": "File", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the file" + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The url of the file. This is a temporary URL and will expire after 30 minutes." + }, + { + "key": "content_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of file" + }, + { + "key": "filesize", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The size of the file in bytes" + }, + { + "key": "width", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The width of the file in pixels, if applicable" + }, + { + "key": "height", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The height of the file in pixels, if applicable" + } + ] + }, + "description": "The value describing a file upload set for a custom attribute" + }, + "group_content": { + "name": "Group Content", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [] + } + } + }, + "description": "The type of object - `group_content` ." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the collection or section." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the collection. Only available for collections." + } + ] + } + } + }, + "description": "The Content of a Group." + }, + "group_translated_content": { + "name": "Group Translated Content", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [] + } + } + }, + "description": "The type of object - group_translated_content." + }, + { + "key": "ar", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Arabic" + }, + { + "key": "bg", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Bulgarian" + }, + { + "key": "bs", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Bosnian" + }, + { + "key": "ca", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Catalan" + }, + { + "key": "cs", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Czech" + }, + { + "key": "da", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Danish" + }, + { + "key": "de", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in German" + }, + { + "key": "el", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Greek" + }, + { + "key": "en", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in English" + }, + { + "key": "es", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Spanish" + }, + { + "key": "et", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Estonian" + }, + { + "key": "fi", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Finnish" + }, + { + "key": "fr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in French" + }, + { + "key": "he", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Hebrew" + }, + { + "key": "hr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Croatian" + }, + { + "key": "hu", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Hungarian" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Indonesian" + }, + { + "key": "it", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Italian" + }, + { + "key": "ja", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Japanese" + }, + { + "key": "ko", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Korean" + }, + { + "key": "lt", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Lithuanian" + }, + { + "key": "lv", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Latvian" + }, + { + "key": "mn", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Mongolian" + }, + { + "key": "nb", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Norwegian" + }, + { + "key": "nl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Dutch" + }, + { + "key": "pl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Polish" + }, + { + "key": "pt", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Portuguese (Portugal)" + }, + { + "key": "ro", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Romanian" + }, + { + "key": "ru", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Russian" + }, + { + "key": "sl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Slovenian" + }, + { + "key": "sr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Serbian" + }, + { + "key": "sv", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Swedish" + }, + { + "key": "tr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Turkish" + }, + { + "key": "vi", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Vietnamese" + }, + { + "key": "pt-BR", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Portuguese (Brazil)" + }, + { + "key": "zh-CN", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Chinese (China)" + }, + { + "key": "zh-TW", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Chinese (Taiwan)" + } + ] + } + } + }, + "description": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group." + }, + "help_center": { + "name": "Help Center", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the Help Center which is given by Intercom." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace which the Help Center belongs to." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the Help Center was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the Help Center was last updated." + }, + { + "key": "identifier", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier of the Help Center. This is used in the URL of the Help Center." + }, + { + "key": "website_turned_on", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the Help Center is turned on or not. This is controlled in your Help Center settings." + }, + { + "key": "display_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The display name of the Help Center only seen by teammates." + } + ] + }, + "description": "Help Centers contain collections" + }, + "help_center_list": { + "name": "Help Centers", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object - `list`." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "help_center" + } + } + } + }, + "description": "An array of Help Center objects" + } + ] + }, + "description": "A list of Help Centers belonging to the App" + }, + "intercom_version": { + "name": "intercom_version", + "shape": { + "type": "enum", + "values": [ + { + "value": "1.0" + }, + { + "value": "1.1" + }, + { + "value": "1.2" + }, + { + "value": "1.3" + }, + { + "value": "1.4" + }, + { + "value": "2.0" + }, + { + "value": "2.1" + }, + { + "value": "2.2" + }, + { + "value": "2.3" + }, + { + "value": "2.4" + }, + { + "value": "2.5" + }, + { + "value": "2.6" + }, + { + "value": "2.7" + }, + { + "value": "2.8" + }, + { + "value": "2.9" + }, + { + "value": "2.10" + }, + { + "value": "2.11" + }, + { + "value": "Unstable" + } + ], + "default": "2.11" + }, + "description": "Intercom API version.
By default, it's equal to the version set in the app package." + }, + "linked_object": { + "name": "Linked Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "ticket" + }, + { + "value": "conversation" + } + ] + }, + "description": "ticket or conversation" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the linked object" + }, + { + "key": "category", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [ + { + "value": "Customer" + }, + { + "value": "Back-office" + }, + { + "value": "Tracker" + } + ] + } + } + }, + "description": "Category of the Linked Ticket Object." + } + ] + }, + "description": "A linked conversation or ticket." + }, + "linked_object_list": { + "name": "Linked Objects", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "Always list." + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of linked objects." + }, + { + "key": "has_more", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not there are more linked objects than returned." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "linked_object" + } + } + } + }, + "description": "An array containing the linked conversations and linked tickets." + } + ] + }, + "description": "An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned." + }, + "merge_contacts_request": { + "name": "Merge contact data", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "from", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact to merge away from. Must be a lead." + }, + { + "key": "into", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact to merge into. Must be a user." + } + ] + }, + "description": "Merge contact data." + }, + "message": { + "name": "Message", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the message" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the message." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the conversation was created." + }, + { + "key": "subject", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The subject of the message. Only present if message_type: email." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The message body, which may contain HTML." + }, + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "email" + }, + { + "value": "inapp" + }, + { + "value": "facebook" + }, + { + "value": "twitter" + } + ] + }, + "description": "The type of message that was sent. Can be email, inapp, facebook or twitter." + }, + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The associated conversation_id" + } + ] + }, + "description": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact." + }, + "multiple_filter_search_request": { + "name": "Multiple Filter Search Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "operator", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "AND" + }, + { + "value": "OR" + } + ] + }, + "description": "An operator to allow boolean inspection between multiple fields." + }, + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "multiple_filter_search_request" + } + } + } + } + } + ] + }, + "description": "Search using Intercoms Search APIs with more than one filter." + }, + "news_item": { + "name": "News Item", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "news-item" + } + ] + }, + "description": "The type of object." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the news item which is given by Intercom." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace which the news item belongs to." + }, + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the news item." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The news item body, which may contain HTML." + }, + { + "key": "sender_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the sender of the news item. Must be a teammate on the workspace." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "draft" + }, + { + "value": "live" + } + ] + }, + "description": "News items will not be visible to your users in the assigned newsfeeds until they are set live." + }, + { + "key": "newsfeed_assignments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "newsfeed_assignment" + } + } + } + }, + "description": "A list of newsfeed_assignments to assign to the specified newsfeed." + }, + { + "key": "labels", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Label names displayed to users to categorize the news item." + }, + { + "key": "cover_image_url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "URL of the image used as cover. Must have .jpg or .png extension." + }, + { + "key": "reactions", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled." + }, + { + "key": "deliver_silently", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "When set to true, the news item will appear in the messenger newsfeed without showing a notification badge." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Timestamp for when the news item was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Timestamp for when the news item was last updated." + } + ] + }, + "description": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers." + }, + "news_item_request": { + "name": "Create News Item Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the news item." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The news item body, which may contain HTML." + }, + { + "key": "sender_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the sender of the news item. Must be a teammate on the workspace." + }, + { + "key": "state", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "enum", + "values": [ + { + "value": "draft" + }, + { + "value": "live" + } + ] + } + } + }, + "description": "News items will not be visible to your users in the assigned newsfeeds until they are set live." + }, + { + "key": "deliver_silently", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge." + }, + { + "key": "labels", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Label names displayed to users to categorize the news item." + }, + { + "key": "reactions", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "description": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled." + }, + { + "key": "newsfeed_assignments", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "newsfeed_assignment" + } + } + } + } + } + }, + "description": "A list of newsfeed_assignments to assign to the specified newsfeed." + } + ] + }, + "description": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers." + }, + "newsfeed": { + "name": "Newsfeed", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the newsfeed which is given by Intercom." + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "newsfeed" + } + ] + }, + "description": "The type of object." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the newsfeed. This name will never be visible to your users." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Timestamp for when the newsfeed was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Timestamp for when the newsfeed was last updated." + } + ] + }, + "description": "A newsfeed is a collection of news items, targeted to a specific audience.\n\nNewsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom.\n" + }, + "newsfeed_assignment": { + "name": "Newsfeed Assignment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "newsfeed_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article)." + }, + { + "key": "published_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is \"draft\"." + } + ] + }, + "description": "Assigns a news item to a newsfeed." + }, + "note": { + "name": "Note", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `note`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the note." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the note was created." + }, + { + "key": "contact", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `contact`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the contact." + } + ] + } + } + }, + "description": "Represents the contact that the note was created about." + }, + { + "key": "author", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "admin" + } + }, + "description": "Optional. Represents the Admin that created the note." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The body text of the note." + } + ] + }, + "description": "Notes allow you to annotate and comment on your contacts." + }, + "note_list": { + "name": "Paginated Response", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `list`." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "note" + } + } + } + }, + "description": "An array of notes." + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of notes." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "A paginated list of notes associated with a contact." + }, + "open_conversation_request": { + "name": "Open Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "open" + } + ] + } + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is performing the action." + } + ] + }, + "description": "Payload of the request to open a conversation" + }, + "pages_link": { + "name": "Pagination Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "pages" + } + ] + } + }, + { + "key": "page", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "next", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch." + }, + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "total_pages", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + }, + "description": "The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.\n\nTheir responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.\n" + }, + "paginated_response": { + "name": "Paginated Response", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + }, + { + "value": "conversation.list" + } + ] + }, + "description": "The type of object" + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of objects." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "undiscriminatedUnion", + "variants": [] + } + } + }, + "description": "An array of Objects" + } + ] + }, + "description": "Paginated Response" + }, + "part_attachment": { + "name": "Part attachment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of attachment" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the attachment" + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL of the attachment" + }, + { + "key": "content_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The content type of the attachment" + }, + { + "key": "filesize", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The size of the attachment" + }, + { + "key": "width", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The width of the attachment" + }, + { + "key": "height", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The height of the attachment" + } + ] + }, + "description": "The file attached to a part" + }, + "phone_switch": { + "name": "Phone Switch", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "phone_call_redirect" + } + ], + "default": "phone_call_redirect" + }, + "description": "" + }, + { + "key": "phone", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger." + } + ] + } + } + }, + "description": "Phone Switch Response" + }, + "redact_conversation_request": { + "name": "redact_conversation_request", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Redact Conversation Part Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "conversation_part" + } + ] + }, + "description": "The type of resource being redacted." + }, + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the conversation." + }, + { + "key": "conversation_part_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the conversation_part." + } + ] + }, + "description": "Payload of the request to redact a conversation part" + }, + { + "displayName": "Redact Conversation Source Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "source" + } + ] + }, + "description": "The type of resource being redacted." + }, + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the conversation." + }, + { + "key": "source_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the source." + } + ] + }, + "description": "Payload of the request to redact a conversation source" + } + ] + } + }, + "reference": { + "name": "Reference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "" + } + ] + }, + "description": "reference to another object" + }, + "reply_conversation_request": { + "name": "reply_conversation_request", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_reply_conversation_request" + } + } + }, + "search_request": { + "name": "Search data", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "query", + "valueShape": { + "type": "undiscriminatedUnion", + "variants": [] + } + }, + { + "key": "pagination", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "starting_after_paging" + } + } + } + } + } + ] + }, + "description": "Search using Intercoms Search APIs." + }, + "segment": { + "name": "Segment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "segment" + } + ] + }, + "description": "The type of object." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier representing the segment." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the segment." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the segment was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the segment was updated." + }, + { + "key": "person_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + }, + { + "value": "user" + } + ] + }, + "description": "Type of the contact: contact (lead) or user." + }, + { + "key": "count", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The number of items in the user segment. It's returned when `include_count=true` is included in the request." + } + ] + }, + "description": "A segment is a group of your contacts defined by the rules that you set." + }, + "segment_list": { + "name": "Segment List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "segment.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "segments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "segment" + } + } + } + }, + "description": "A list of Segment objects" + }, + { + "key": "pages", + "valueShape": { + "type": "object", + "extends": [], + "properties": [] + }, + "description": "A pagination object, which may be empty, indicating no further pages to fetch." + } + ] + }, + "description": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated." + }, + "single_filter_search_request": { + "name": "Single Filter Search Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The accepted field that you want to search on." + }, + { + "key": "operator", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "=" + }, + { + "value": "!=" + }, + { + "value": "IN" + }, + { + "value": "NIN" + }, + { + "value": "<" + }, + { + "value": ">" + }, + { + "value": "~" + }, + { + "value": "!~" + }, + { + "value": "^" + }, + { + "value": "$" + } + ] + }, + "description": "The accepted operators you can use to define how you want to search for the value." + }, + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The value that you want to search on." + } + ] + }, + "description": "Search using Intercoms Search APIs with a single filter." + }, + "sla_applied": { + "name": "Applied SLA", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "object type" + }, + { + "key": "sla_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the SLA as given by the teammate when it was created." + }, + { + "key": "sla_status", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "hit" + }, + { + "value": "missed" + }, + { + "value": "cancelled" + }, + { + "value": "active" + } + ] + }, + "description": "SLA statuses:\n - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.\n - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies.\n - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events." + } + ] + } + } + }, + "description": "The SLA Applied object contains the details for which SLA has been applied to this conversation.\nImportant: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.\n" + }, + "snooze_conversation_request": { + "name": "Snooze Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "snoozed" + } + ] + } + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is performing the action." + }, + { + "key": "snoozed_until", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time you want the conversation to reopen." + } + ] + }, + "description": "Payload of the request to snooze a conversation" + }, + "social_profile": { + "name": "Social Profile", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "value is \"social_profile\"" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Social media profile" + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "The name of the Social media profile" + } + ] + }, + "description": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile." + }, + "starting_after_paging": { + "name": "Pagination: Starting After", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of results to fetch per page." + }, + { + "key": "starting_after", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The cursor to use in the next request to get the next page of results." + } + ] + } + } + } + }, + "subscription_type": { + "name": "Subscription Types", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the object - subscription" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier representing the subscription type." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "live" + }, + { + "value": "draft" + }, + { + "value": "archived" + } + ] + }, + "description": "The state of the subscription type." + }, + { + "key": "default_translation", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "translation" + } + } + }, + { + "key": "translations", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "translation" + } + } + } + }, + "description": "An array of translations objects with the localised version of the subscription type in each available locale within your translation settings." + }, + { + "key": "consent_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "opt_out" + }, + { + "value": "opt_in" + } + ] + }, + "description": "Describes the type of consent." + }, + { + "key": "content_types", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "enum", + "values": [ + { + "value": "email" + }, + { + "value": "sms_message" + } + ] + } + } + }, + "description": "The message types that this subscription supports - can contain `email` or `sms_message`." + } + ] + }, + "description": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them." + }, + "subscription_type_list": { + "name": "Subscription Types", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "subscription_type" + } + } + } + }, + "description": "A list of subscription type objects associated with the workspace ." + } + ] + }, + "description": "A list of subscription type objects." + }, + "tag": { + "name": "Tag", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "value is \"tag\"" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the tag" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag" + }, + { + "key": "applied_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the tag was applied to the object" + }, + { + "key": "applied_by", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "reference" + } + } + } + ] + }, + "description": "A tag allows you to label your contacts, companies, and conversations and list them using that tag." + }, + "tag_company_request": { + "name": "Tag Company Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag, which will be created if not found." + }, + { + "key": "companies", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the company." + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The company id you have defined for the company." + } + ] + } + } + }, + "description": "The id or company_id of the company can be passed as input parameters." + } + ] + }, + "description": "You can tag a single company or a list of companies." + }, + "tag_list": { + "name": "Tags", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + } + } + }, + "description": "A list of tags objects associated with the workspace ." + } + ] + }, + "description": "A list of tags objects in the workspace." + }, + "tag_multiple_users_request": { + "name": "Tag Users Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag, which will be created if not found." + }, + { + "key": "users", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the user." + } + ] + } + } + } + } + ] + }, + "description": "You can tag a list of users." + }, + "tags": { + "name": "Tags", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "tag.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "tags", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + } + } + }, + "description": "A list of tags objects associated with the conversation." + } + ] + }, + "description": "A list of tags objects associated with a conversation" + }, + "team": { + "name": "Team", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Value is always \"team\"" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the team" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the team" + }, + { + "key": "admin_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The list of admin IDs that are a part of the team." + }, + { + "key": "admin_priority_level", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "admin_priority_level" + } + } + } + ] + }, + "description": "Teams are groups of admins in Intercom." + }, + "team_list": { + "name": "Team List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "team.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "teams", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "team" + } + } + } + }, + "description": "A list of team objects" + } + ] + }, + "description": "This will return a list of team objects for the App." + }, + "team_priority_level": { + "name": "Team Priority Level", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "primary_team_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The primary team ids for the team" + }, + { + "key": "secondary_team_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The secondary team ids for the team" + } + ] + } + } + }, + "description": "Admin priority levels for teams" + }, + "ticket": { + "name": "Ticket", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "ticket" + } + ], + "default": "ticket" + }, + "description": "Always ticket" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket which is given by Intercom." + }, + { + "key": "ticket_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries." + }, + { + "key": "category", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "Customer" + }, + { + "value": "Back-office" + }, + { + "value": "Tracker" + } + ] + }, + "description": "Category of the Ticket." + }, + { + "key": "ticket_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_custom_attributes" + } + } + }, + { + "key": "ticket_state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "submitted" + }, + { + "value": "in_progress" + }, + { + "value": "waiting_on_customer" + }, + { + "value": "resolved" + } + ] + }, + "description": "The state the ticket is currently in" + }, + { + "key": "ticket_type", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type" + } + } + }, + { + "key": "contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_contacts" + } + } + }, + { + "key": "admin_assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the admin assigned to the ticket." + }, + { + "key": "team_assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the team assigned to the ticket." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the ticket was created as a UTC Unix timestamp." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the ticket was updated as a UTC Unix timestamp." + }, + { + "key": "open", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the ticket is open. If false, the ticket is closed." + }, + { + "key": "snoozed_until", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed." + }, + { + "key": "linked_objects", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "linked_object_list" + } + } + }, + { + "key": "ticket_parts", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_parts" + } + } + }, + { + "key": "is_shared", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the ticket is shared with the customer." + }, + { + "key": "ticket_state_internal_label", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The state the ticket is currently in, in a human readable form - visible in Intercom" + }, + { + "key": "ticket_state_external_label", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal." + } + ] + } + } + }, + "description": "Tickets are how you track requests from your users." + }, + "ticket_contacts": { + "name": "Contacts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact.list" + } + ] + }, + "description": "always contact.list" + }, + { + "key": "contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_reference" + } + } + } + }, + "description": "The list of contacts affected by this ticket." + } + ] + }, + "description": "The list of contacts affected by a ticket." + }, + "ticket_custom_attributes": { + "name": "Ticket Attributes", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are `_default_title_` and `_default_description_`." + }, + "ticket_list": { + "name": "Ticket List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "ticket.list" + } + ] + }, + "description": "Always ticket.list" + }, + { + "key": "tickets", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket" + } + } + } + }, + "description": "The list of ticket objects" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of objects." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "Tickets are how you track requests from your users." + }, + "ticket_part": { + "name": "Ticket Part", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Always ticket_part" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the ticket part." + }, + { + "key": "part_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of ticket part." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The message body, which may contain HTML." + }, + { + "key": "previous_ticket_state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "submitted" + }, + { + "value": "in_progress" + }, + { + "value": "waiting_on_customer" + }, + { + "value": "resolved" + } + ] + }, + "description": "The previous state of the ticket." + }, + { + "key": "ticket_state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "submitted" + }, + { + "value": "in_progress" + }, + { + "value": "waiting_on_customer" + }, + { + "value": "resolved" + } + ] + }, + "description": "The state of the ticket." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the ticket part was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the ticket part was updated." + }, + { + "key": "assigned_to", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "reference" + } + } + } + }, + "description": "The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)" + }, + { + "key": "author", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_part_author" + } + } + }, + { + "key": "attachments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "part_attachment" + } + } + } + }, + "description": "A list of attachments for the part." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The external id of the ticket part" + }, + { + "key": "redacted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the ticket part has been redacted." + } + ] + }, + "description": "A Ticket Part represents a message in the ticket." + }, + "ticket_part_author": { + "name": "Ticket part author", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin" + }, + { + "value": "bot" + }, + { + "value": "team" + }, + { + "value": "user" + } + ] + }, + "description": "The type of the author" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the author" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the author" + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "email" + } + } + }, + "description": "The email of the author" + } + ] + }, + "description": "The author that wrote or triggered the part. Can be a bot, admin, team or user." + }, + "ticket_parts": { + "name": "Ticket Parts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "ticket_part.list" + } + ] + }, + "description": "" + }, + { + "key": "ticket_parts", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_part" + } + } + } + }, + "description": "A list of Ticket Part objects for each ticket. There is a limit of 500 parts." + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "" + } + ] + }, + "description": "A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts." + }, + "ticket_reply": { + "name": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "ticket_part" + } + ] + }, + "description": "Always ticket_part" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the part." + }, + { + "key": "part_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "note" + }, + { + "value": "comment" + }, + { + "value": "quick_reply" + } + ] + }, + "description": "Type of the part" + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The message body, which may contain HTML." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the note was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the note was updated." + }, + { + "key": "author", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_part_author" + } + } + }, + { + "key": "attachments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "part_attachment" + } + } + } + }, + "description": "A list of attachments for the part." + }, + { + "key": "redacted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the ticket part has been redacted." + } + ] + }, + "description": "A Ticket Part representing a note, comment, or quick_reply on a ticket" + }, + "ticket_request_custom_attributes": { + "name": "Ticket Attributes", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are `_default_title_` and `_default_description_`. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). For example, if the ticket type has an attribute called `priority` of type `list`, the key should be `priority` and the value of the attribute should be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`)." + }, + "ticket_type": { + "name": "Ticket Type", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `ticket_type`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the ticket type." + }, + { + "key": "category", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "Customer" + }, + { + "value": "Back-office" + }, + { + "value": "Tracker" + } + ] + }, + "description": "Category of the Ticket Type." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the ticket type" + }, + { + "key": "icon", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The icon of the ticket type" + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace that the ticket type belongs to." + }, + { + "key": "ticket_type_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type_attribute_list" + } + } + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the ticket type is archived or not." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The date and time the ticket type was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The date and time the ticket type was last updated." + } + ] + } + } + }, + "description": "A ticket type, used to define the data fields to be captured in a ticket." + }, + "ticket_type_attribute": { + "name": "Ticket Type Attribute", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `ticket_type_attribute`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the ticket type attribute." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace that the ticket type attribute belongs to." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type attribute" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the ticket type attribute" + }, + { + "key": "data_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the data attribute (allowed values: \"string list integer decimal boolean datetime files\")" + }, + { + "key": "input_options", + "valueShape": { + "type": "object", + "extends": [], + "properties": [] + }, + "description": "Input options for the attribute" + }, + { + "key": "order", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The order of the attribute against other attributes" + }, + { + "key": "required_to_create", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Whether the attribute is required or not for teammates." + }, + { + "key": "required_to_create_for_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Whether the attribute is required or not for contacts." + }, + { + "key": "visible_on_create", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + }, + "description": "Whether the attribute is visible or not to teammates." + }, + { + "key": "visible_to_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + }, + "description": "Whether the attribute is visible or not to contacts." + }, + { + "key": "default", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the attribute is built in or not." + }, + { + "key": "ticket_type_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the ticket type that the attribute belongs to." + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the ticket type attribute is archived or not." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The date and time the ticket type attribute was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The date and time the ticket type attribute was last updated." + } + ] + } + } + }, + "description": "Ticket type attribute, used to define each data field to be captured in a ticket." + }, + "ticket_type_attribute_list": { + "name": "Ticket Type Attributes", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `ticket_type_attributes.list`." + }, + { + "key": "ticket_type_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type_attribute" + } + } + } + }, + "description": "A list of ticket type attributes associated with a given ticket type." + } + ] + }, + "description": "A list of attributes associated with a given ticket type." + }, + "ticket_type_list": { + "name": "Ticket Types", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `ticket_type.list`." + }, + { + "key": "ticket_types", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type" + } + } + } + }, + "description": "A list of ticket_types associated with a given workspace." + } + ] + }, + "description": "A list of ticket types associated with a given workspace." + }, + "translation": { + "name": "Translation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The localised name of the subscription type." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The localised description of the subscription type." + }, + { + "key": "locale", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The two character identifier for the language of the translation object." + } + ] + }, + "description": "A translation object contains the localised details of a subscription type." + }, + "untag_company_request": { + "name": "Untag Company Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag which will be untagged from the company" + }, + { + "key": "companies", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the company." + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The company id you have defined for the company." + }, + { + "key": "untag", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Always set to true" + } + ] + } + } + }, + "description": "The id or company_id of the company can be passed as input parameters." + } + ] + }, + "description": "You can tag a single company or a list of companies." + }, + "update_article_request": { + "name": "Update Article Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the article.For multilingual articles, this will be the title of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the article. For multilingual articles, this will be the description of the default language's content." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The content of the article. For multilingual articles, this will be the body of the default language's content." + }, + { + "key": "author_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "published" + }, + { + "value": "draft" + } + ] + }, + "description": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content." + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the article's parent collection or section. An article without this field stands alone." + }, + { + "key": "parent_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of parent, which can either be a `collection` or `section`." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_translated_content" + } + } + } + ] + } + } + }, + "description": "You can Update an Article" + }, + "update_collection_request": { + "name": "Update Collection Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the collection. For multilingual collections, this will be the description of the default language's content." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_translated_content" + } + } + } + } + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The id of the parent collection. If `null` then it will be updated as the first level collection." + } + ] + }, + "description": "You can update a collection" + }, + "update_contact_request": { + "name": "Update Contact Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "role", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role of the contact." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the contact which is given to Intercom" + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The contacts email" + }, + { + "key": "phone", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The contacts phone" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The contacts name" + }, + { + "key": "avatar", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "An image URL containing the avatar of a contact" + }, + { + "key": "signed_up_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time specified for when a contact signed up" + }, + { + "key": "last_seen_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)" + }, + { + "key": "owner_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of an admin that has been assigned account ownership of the contact" + }, + { + "key": "unsubscribed_from_emails", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Whether the contact is unsubscribed from emails" + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [] + } + } + }, + "description": "The custom attributes which are set for the contact" + } + ] + }, + "description": "You can update a contact" + }, + "update_conversation_request": { + "name": "Update Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "read", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Mark a conversation as read within Intercom." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "custom_attributes" + } + } + } + ] + }, + "description": "Payload of the request to update a conversation" + }, + "update_data_attribute_request": { + "name": "Update Data Attribute Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the attribute is to be archived or not." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The readable description you see in the UI for the attribute." + }, + { + "key": "options", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "To create list attributes. Provide a set of hashes with `value` as the key of the options you want to make. `data_type` must be `string`." + }, + { + "key": "messenger_writable", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Can this attribute be updated by the Messenger" + } + ] + }, + "description": "" + }, + "update_ticket_request": { + "name": "Update Ticket Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "ticket_attributes", + "valueShape": { + "type": "object", + "extends": [], + "properties": [] + }, + "description": "The attributes set on the ticket." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "in_progress" + }, + { + "value": "waiting_on_customer" + }, + { + "value": "resolved" + } + ] + }, + "description": "The state of the ticket." + }, + { + "key": "open", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it." + }, + { + "key": "is_shared", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Specify whether the ticket is visible to users." + }, + { + "key": "snoozed_until", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time you want the ticket to reopen." + }, + { + "key": "assignment", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the admin performing the action." + }, + { + "key": "assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it." + } + ] + } + } + ] + }, + "description": "You can update a Ticket" + }, + "update_ticket_type_attribute_request": { + "name": "Update Ticket Type Attribute Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type attribute" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the attribute presented to the teammate or contact" + }, + { + "key": "required_to_create", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox." + }, + { + "key": "required_to_create_for_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger." + }, + { + "key": "visible_on_create", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + }, + "description": "Whether the attribute is visible to teammates when creating a ticket in Inbox." + }, + { + "key": "visible_to_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + }, + "description": "Whether the attribute is visible to contacts when creating a ticket in Messenger." + }, + { + "key": "multiline", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the attribute allows multiple lines of text (only applicable to string attributes)" + }, + { + "key": "list_items", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A comma delimited list of items for the attribute value (only applicable to list attributes)" + }, + { + "key": "allow_multiple_values", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)" + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)" + } + ] + }, + "description": "You can update a Ticket Type Attribute" + }, + "update_ticket_type_request": { + "name": "Update Ticket Type Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the ticket type." + }, + { + "key": "category", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "Customer" + }, + { + "value": "Back-office" + }, + { + "value": "Tracker" + } + ] + }, + "description": "Category of the Ticket Type." + }, + { + "key": "icon", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "🎟️" + } + } + }, + "description": "The icon of the ticket type." + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "The archived status of the ticket type." + }, + { + "key": "is_internal", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute." + } + ] + } + } + }, + "description": "The request payload for updating a ticket type.\nYou can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + }, + "visitor": { + "name": "Visitor", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "visitor" + } + } + }, + "description": "Value is 'visitor'" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the Visitor." + }, + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Automatically generated identifier for the Visitor." + }, + { + "key": "anonymous", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this visitor is anonymous." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "email" + } + } + }, + "description": "The email of the visitor." + }, + { + "key": "phone", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The phone number of the visitor." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the visitor." + }, + { + "key": "pseudonym", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The pseudonym of the visitor." + }, + { + "key": "avatar", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "avatar" + } + } + }, + "description": "" + }, + { + "key": "image_url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "This object represents the avatar associated with the visitor." + } + ] + } + }, + { + "key": "app_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the app the visitor is associated with." + }, + { + "key": "companies", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "company.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "companies", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + } + } + } + } + ] + } + }, + { + "key": "location_data", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "location_data" + } + } + }, + "description": "" + }, + { + "key": "city_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The city name of the visitor." + }, + { + "key": "continent_code", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The continent code of the visitor." + }, + { + "key": "country_code", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The country code of the visitor." + }, + { + "key": "country_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The country name of the visitor." + }, + { + "key": "postal_code", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The postal code of the visitor." + }, + { + "key": "region_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The region name of the visitor." + }, + { + "key": "timezone", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The timezone of the visitor." + } + ] + } + }, + { + "key": "las_request_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the Lead last recorded making a request." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the Visitor was added to Intercom." + }, + { + "key": "remote_created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the Visitor was added to Intercom." + }, + { + "key": "signed_up_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the Visitor signed up for your product." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the Visitor was updated." + }, + { + "key": "session_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of sessions the Visitor has had." + }, + { + "key": "social_profiles", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "social_profile.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "social_profiles", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + { + "key": "owner_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The id of the admin that owns the Visitor." + }, + { + "key": "unsubscribed_from_emails", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the Visitor is unsubscribed from emails." + }, + { + "key": "marked_email_as_spam", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this visitor has marked an email as spam." + }, + { + "key": "has_hard_bounced", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this visitor has had a hard bounce." + }, + { + "key": "tags", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "tag.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "tags", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "tag" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the tag." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag." + } + ] + } + } + } + } + ] + } + }, + { + "key": "segments", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "segment.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "segments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The custom attributes you have set on the Visitor." + }, + { + "key": "referrer", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The referer of the visitor." + }, + { + "key": "utm_campaign", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The utm_campaign of the visitor." + }, + { + "key": "utm_content", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The utm_content of the visitor." + }, + { + "key": "utm_medium", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The utm_medium of the visitor." + }, + { + "key": "utm_source", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The utm_source of the visitor." + }, + { + "key": "utm_term", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The utm_term of the visitor." + }, + { + "key": "do_not_track", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Identifies if this visitor has do not track enabled." + } + ] + } + } + }, + "description": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete." + }, + "visitor_deleted_object": { + "name": "Visitor Deleted Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the visitor which is given by Intercom." + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "visitor" + } + ] + }, + "description": "The type of object which was deleted" + }, + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Automatically generated identifier for the Visitor." + } + ] + }, + "description": "Response returned when an object is deleted" + } + }, + "subpackages": { + "admins": { + "id": "admins", + "name": "Admins", + "displayName": "Admins" + }, + "articles": { + "id": "articles", + "name": "Articles", + "displayName": "Articles" + }, + "helpCenter": { + "id": "helpCenter", + "name": "Help Center", + "displayName": "Help Center" + }, + "companies": { + "id": "companies", + "name": "Companies", + "displayName": "Companies" + }, + "contacts": { + "id": "contacts", + "name": "Contacts", + "displayName": "Contacts" + }, + "notes": { + "id": "notes", + "name": "Notes", + "displayName": "Notes" + }, + "segments": { + "id": "segments", + "name": "Segments", + "displayName": "Segments" + }, + "subscriptionTypes": { + "id": "subscriptionTypes", + "name": "Subscription Types", + "displayName": "Subscription Types" + }, + "tags": { + "id": "tags", + "name": "Tags", + "displayName": "Tags" + }, + "conversations": { + "id": "conversations", + "name": "Conversations", + "displayName": "Conversations" + }, + "dataAttributes": { + "id": "dataAttributes", + "name": "Data Attributes", + "displayName": "Data Attributes" + }, + "dataEvents": { + "id": "dataEvents", + "name": "Data Events", + "displayName": "Data Events" + }, + "dataExport": { + "id": "dataExport", + "name": "Data Export", + "displayName": "Data Export" + }, + "messages": { + "id": "messages", + "name": "Messages", + "displayName": "Messages" + }, + "news": { + "id": "news", + "name": "News", + "displayName": "News" + }, + "switch": { + "id": "switch", + "name": "Switch", + "displayName": "Switch" + }, + "teams": { + "id": "teams", + "name": "Teams", + "displayName": "Teams" + }, + "ticketTypeAttributes": { + "id": "ticketTypeAttributes", + "name": "Ticket Type Attributes", + "displayName": "Ticket Type Attributes" + }, + "ticketTypes": { + "id": "ticketTypes", + "name": "Ticket Types", + "displayName": "Ticket Types" + }, + "tickets": { + "id": "tickets", + "name": "Tickets", + "displayName": "Tickets" + }, + "visitors": { + "id": "visitors", + "name": "Visitors", + "displayName": "Visitors" + } + }, + "auths": { + "bearerAuth": { + "type": "bearerAuth" + } + } +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/openapi-filter.json b/packages/parsers/src/openapi/__test__/__snapshots__/openapi-filter.json new file mode 100644 index 0000000000..e325d48cad --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/openapi-filter.json @@ -0,0 +1,42377 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_admins.identifyAdmin": { + "id": "endpoint_admins.identifyAdmin", + "description": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", + "namespace": [ + "Admins" + ], + "displayName": "Identify an admin", + "operationId": "identifyAdmin", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "me" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "admin_with_app" + } + }, + "description": "Successful response" + } + ], + "errors": [], + "examples": [ + { + "path": "/me", + "responseStatusCode": 200, + "name": "Successful response", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "admin", + "id": "991267390", + "email": "admin1@email.com", + "name": "Ciaran1 Lee", + "email_verified": true, + "app": { + "type": "app", + "id_code": "this_is_an_id1_that_should_be_at_least_40", + "name": "MyApp 1", + "created_at": 1719492696, + "secure": false, + "identity_verification": false, + "timezone": "America/Los_Angeles", + "region": "US" + }, + "avatar": { + "type": "avatar", + "image_url": "https://static.intercomassets.com/assets/default-avatars/admins/128.png" + }, + "has_inbox_seat": true + } + } + } + ] + }, + "endpoint_admins.setAwayAdmin": { + "id": "endpoint_admins.setAwayAdmin", + "description": "You can set an Admin as away for the Inbox.", + "namespace": [ + "Admins" + ], + "displayName": "Set an admin to away", + "operationId": "setAwayAdmin", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "admins" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "away" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier of a given admin" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "away_mode_enabled", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + }, + "description": "Set to \"true\" to change the status of the admin to away." + }, + { + "key": "away_mode_reassign", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Set to \"true\" to assign any new conversation replies to your default inbox." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "admin" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Admin not found", + "name": "Not Found", + "examples": [ + { + "name": "Admin not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "admin_not_found", + "message": "Admin for admin_id not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/admins/{id}/away", + "responseStatusCode": 200, + "name": "Successful response", + "pathParameters": { + "id": 0 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "admin", + "id": "991267391", + "name": "Ciaran2 Lee", + "email": "admin2@email.com", + "away_mode_enabled": true, + "away_mode_reassign": true, + "has_inbox_seat": true, + "team_ids": [] + } + } + }, + { + "path": "/admins/{id}/away", + "responseStatusCode": 200, + "pathParameters": { + "id": 0 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "away_mode_enabled": true, + "away_mode_reassign": true + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/admins/{id}/away", + "responseStatusCode": 200, + "pathParameters": { + "id": 0 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "away_mode_enabled": true, + "away_mode_reassign": true + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/admins/{id}/away", + "responseStatusCode": 200, + "pathParameters": { + "id": 0 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "away_mode_enabled": true, + "away_mode_reassign": true + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_admins.listActivityLogs": { + "id": "endpoint_admins.listActivityLogs", + "description": "You can get a log of activities by all admins in an app.", + "namespace": [ + "Admins" + ], + "displayName": "List all activity logs", + "operationId": "listActivityLogs", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "admins" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "activity_logs" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "created_at_after", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The start date that you request data for. It must be formatted as a UNIX timestamp." + }, + { + "key": "created_at_before", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The end date that you request data for. It must be formatted as a UNIX timestamp." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "activity_log_list" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/admins/activity_logs", + "responseStatusCode": 200, + "name": "Successful response", + "queryParameters": { + "created_at_after": "1677253093", + "created_at_before": "1677861493" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "activity_log.list", + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 20, + "total_pages": 1 + }, + "activity_logs": [ + { + "id": "test-uuid-replacement", + "performed_by": { + "type": "admin", + "id": "991267395", + "email": "admin5@email.com", + "ip": "127.0.0.1" + }, + "metadata": { + "message": { + "id": 123, + "title": "Initial message title" + }, + "before": "Initial message title", + "after": "Eventual message title" + }, + "created_at": 1719492702, + "activity_type": "message_state_change", + "activity_description": "Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title." + }, + { + "id": "test-uuid-replacement", + "performed_by": { + "type": "admin", + "id": "991267395", + "email": "admin5@email.com", + "ip": "127.0.0.1" + }, + "metadata": { + "before": "before", + "after": "after" + }, + "created_at": 1719492702, + "activity_type": "app_name_change", + "activity_description": "Ciaran5 Lee changed your app name from before to after." + } + ] + } + } + } + ] + }, + "endpoint_admins.listAdmins": { + "id": "endpoint_admins.listAdmins", + "description": "You can fetch a list of admins for a given workspace.", + "namespace": [ + "Admins" + ], + "displayName": "List all admins", + "operationId": "listAdmins", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "admins" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "admin_list" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/admins", + "responseStatusCode": 200, + "name": "Successful response", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "admin.list", + "admins": [ + { + "type": "admin", + "email": "admin7@email.com", + "id": "991267397", + "name": "Ciaran7 Lee", + "away_mode_enabled": false, + "away_mode_reassign": false, + "has_inbox_seat": true, + "team_ids": [] + } + ] + } + } + } + ] + }, + "endpoint_admins.retrieveAdmin": { + "id": "endpoint_admins.retrieveAdmin", + "description": "You can retrieve the details of a single admin.", + "namespace": [ + "Admins" + ], + "displayName": "Retrieve an admin", + "operationId": "retrieveAdmin", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "admins" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier of a given admin" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "admin" + } + }, + "description": "Admin found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Admin not found", + "name": "Not Found", + "examples": [ + { + "name": "Admin not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "admin_not_found", + "message": "Admin not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/admins/{id}", + "responseStatusCode": 200, + "name": "Admin found", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "admin", + "id": "991267399", + "name": "Ciaran9 Lee", + "email": "admin9@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false, + "has_inbox_seat": true, + "team_ids": [] + } + } + } + ] + }, + "endpoint_articles.listArticles": { + "id": "endpoint_articles.listArticles", + "description": "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.\n\n> 📘 How are the articles sorted and ordered?\n>\n> 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.\n", + "namespace": [ + "Articles" + ], + "displayName": "List all articles", + "operationId": "listArticles", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "article_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 25, + "total_pages": 1 + }, + "total_count": 1, + "data": [ + { + "id": "39", + "type": "article", + "workspace_id": "this_is_an_id33_that_should_be_at_least_4", + "parent_id": 143, + "parent_type": "collection", + "parent_ids": [], + "title": "This is the article title", + "description": "", + "body": "", + "author_id": 991267402, + "state": "published", + "created_at": 1719492707, + "updated_at": 1719492707, + "url": "http://help-center.test/myapp-33/en/articles/39-this-is-the-article-title" + } + ] + } + } + } + ] + }, + "endpoint_articles.createArticle": { + "id": "endpoint_articles.createArticle", + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "namespace": [ + "Articles" + ], + "displayName": "Create an article", + "operationId": "createArticle", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_article_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "article" + } + }, + "description": "article created" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Bad Request", + "name": "Bad Request", + "examples": [ + { + "name": "Bad Request", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_not_found", + "message": "author_id must be in the main body or default locale translated_content object" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles", + "responseStatusCode": 200, + "name": "article created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "42", + "type": "article", + "workspace_id": "this_is_an_id37_that_should_be_at_least_4", + "parent_id": 145, + "parent_type": "collection", + "parent_ids": [], + "statistics": { + "type": "article_statistics", + "views": 0, + "conversations": 0, + "reactions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "sad_reaction_percentage": 0 + }, + "title": "Thanks for everything", + "description": "Description of the Article", + "body": "

Body of the Article

", + "author_id": 991267407, + "state": "published", + "created_at": 1719492710, + "updated_at": 1719492710, + "url": "http://help-center.test/myapp-37/en/articles/42-thanks-for-everything" + } + } + }, + { + "path": "/articles", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/articles", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_articles.retrieveArticle": { + "id": "endpoint_articles.retrieveArticle", + "description": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`.", + "namespace": [ + "Articles" + ], + "displayName": "Retrieve an article", + "operationId": "retrieveArticle", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the article which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "article" + } + }, + "description": "Article found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Article not found", + "name": "Not Found", + "examples": [ + { + "name": "Article not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "name": "Article found", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "45", + "type": "article", + "workspace_id": "this_is_an_id43_that_should_be_at_least_4", + "parent_id": 148, + "parent_type": "collection", + "parent_ids": [], + "statistics": { + "type": "article_statistics", + "views": 0, + "conversations": 0, + "reactions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "sad_reaction_percentage": 0 + }, + "title": "This is the article title", + "description": "", + "body": "", + "author_id": 991267412, + "state": "published", + "created_at": 1719492712, + "updated_at": 1719492712, + "url": "http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title" + } + } + } + ] + }, + "endpoint_articles.updateArticle": { + "id": "endpoint_articles.updateArticle", + "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", + "namespace": [ + "Articles" + ], + "displayName": "Update an article", + "operationId": "updateArticle", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the article which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_article_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "article" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Article Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Article Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "48", + "type": "article", + "workspace_id": "this_is_an_id49_that_should_be_at_least_4", + "parent_id": 151, + "parent_type": "collection", + "parent_ids": [], + "statistics": { + "type": "article_statistics", + "views": 0, + "conversations": 0, + "reactions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "sad_reaction_percentage": 0 + }, + "title": "Christmas is here!", + "description": "", + "body": "

New gifts in store for the jolly season

", + "author_id": 991267418, + "state": "published", + "created_at": 1719492714, + "updated_at": 1719492714, + "url": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here" + } + } + }, + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "48", + "type": "article", + "workspace_id": "this_is_an_id49_that_should_be_at_least_4", + "parent_id": 151, + "parent_type": "collection", + "parent_ids": [], + "statistics": { + "type": "article_statistics", + "views": 0, + "conversations": 0, + "reactions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "sad_reaction_percentage": 0 + }, + "title": "Christmas is here!", + "description": "", + "body": "

New gifts in store for the jolly season

", + "author_id": 991267418, + "state": "published", + "created_at": 1719492714, + "updated_at": 1719492714, + "url": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here" + } + } + }, + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_articles.deleteArticle": { + "id": "endpoint_articles.deleteArticle", + "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", + "namespace": [ + "Articles" + ], + "displayName": "Delete an article", + "operationId": "deleteArticle", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the article which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "deleted_article_object" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Article Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Article Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "51", + "object": "article", + "deleted": true + } + } + } + ] + }, + "endpoint_articles.searchArticles": { + "id": "endpoint_articles.searchArticles", + "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", + "namespace": [ + "Articles" + ], + "displayName": "Search for articles", + "operationId": "searchArticles", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "articles" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "search" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "phrase", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The phrase within your articles to search for." + }, + { + "key": "state", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The state of the Articles returned. One of `published`, `draft` or `all`." + }, + { + "key": "help_center_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The ID of the Help Center to search in." + }, + { + "key": "highlight", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Return a highlighted version of the matching content within your articles. Refer to the response schema for more details." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "article_search_response" + } + }, + "description": "Search successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/articles/search", + "responseStatusCode": 200, + "name": "Search successful", + "queryParameters": { + "phrase": "Getting started", + "state": "published", + "help_center_id": 123, + "highlight": false + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "total_count": 1, + "data": { + "articles": [ + { + "id": "55", + "type": "article", + "workspace_id": "this_is_an_id61_that_should_be_at_least_4", + "parent_id": null, + "parent_type": null, + "parent_ids": [], + "title": "Title 1", + "description": "", + "body": "", + "author_id": 991267431, + "state": "draft", + "created_at": 1719492719, + "updated_at": 1719492719, + "url": null + } + ], + "highlights": [] + }, + "pages": { + "type": "pages", + "page": 1, + "total_pages": 1, + "per_page": 10 + } + } + } + } + ] + }, + "endpoint_helpCenter.listAllCollections": { + "id": "endpoint_helpCenter.listAllCollections", + "description": "You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`.\n\nCollections 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 collections first.\n", + "namespace": [ + "Help Center" + ], + "displayName": "List all collections", + "operationId": "listAllCollections", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "collections" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "collection_list" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/collections", + "responseStatusCode": 200, + "name": "Successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "id": "159", + "workspace_id": "this_is_an_id65_that_should_be_at_least_4", + "name": "English collection title", + "url": "http://help-center.test/myapp-65/collection-17", + "order": 17, + "created_at": 1719492720, + "updated_at": 1719492720, + "description": "english collection description", + "icon": "bookmark", + "parent_id": null, + "help_center_id": 79 + }, + { + "id": "160", + "workspace_id": "this_is_an_id65_that_should_be_at_least_4", + "name": "English section title", + "url": "http://help-center.test/myapp-65/section-1", + "order": 1, + "created_at": 1719492720, + "updated_at": 1719492720, + "description": null, + "icon": "bookmark", + "parent_id": "159", + "help_center_id": null + } + ], + "total_count": 2, + "pages": { + "type": "pages", + "page": 1, + "per_page": 20, + "total_pages": 1 + } + } + } + } + ] + }, + "endpoint_helpCenter.createCollection": { + "id": "endpoint_helpCenter.createCollection", + "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", + "namespace": [ + "Help Center" + ], + "displayName": "Create a collection", + "operationId": "createCollection", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "collections" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_collection_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "collection" + } + }, + "description": "collection created" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Bad Request", + "name": "Bad Request", + "examples": [ + { + "name": "Bad Request", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_not_found", + "message": "Name is a required parameter." + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/collections", + "responseStatusCode": 200, + "name": "collection created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "165", + "workspace_id": "this_is_an_id69_that_should_be_at_least_4", + "name": "Thanks for everything", + "url": "http://help-center.test/myapp-69/", + "order": 1, + "created_at": 1719492721, + "updated_at": 1719492721, + "description": "", + "icon": "book-bookmark", + "parent_id": null, + "help_center_id": 81 + } + } + }, + { + "path": "/help_center/collections", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/help_center/collections", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_helpCenter.retrieveCollection": { + "id": "endpoint_helpCenter.retrieveCollection", + "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", + "namespace": [ + "Help Center" + ], + "displayName": "Retrieve a collection", + "operationId": "retrieveCollection", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "collections" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the collection which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "collection" + } + }, + "description": "Collection found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Collection not found", + "name": "Not Found", + "examples": [ + { + "name": "Collection not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "name": "Collection found", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "170", + "workspace_id": "this_is_an_id75_that_should_be_at_least_4", + "name": "English collection title", + "url": "http://help-center.test/myapp-75/collection-22", + "order": 22, + "created_at": 1719492723, + "updated_at": 1719492723, + "description": "english collection description", + "icon": "bookmark", + "parent_id": null, + "help_center_id": 84 + } + } + } + ] + }, + "endpoint_helpCenter.updateCollection": { + "id": "endpoint_helpCenter.updateCollection", + "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", + "namespace": [ + "Help Center" + ], + "displayName": "Update a collection", + "operationId": "updateCollection", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "collections" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the collection which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_collection_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "collection" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Collection Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Collection Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "176", + "workspace_id": "this_is_an_id81_that_should_be_at_least_4", + "name": "Update collection name", + "url": "http://help-center.test/myapp-81/collection-25", + "order": 25, + "created_at": 1719492724, + "updated_at": 1719492724, + "description": "english collection description", + "icon": "folder", + "parent_id": null, + "help_center_id": 87 + } + } + }, + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "176", + "workspace_id": "this_is_an_id81_that_should_be_at_least_4", + "name": "Update collection name", + "url": "http://help-center.test/myapp-81/collection-25", + "order": 25, + "created_at": 1719492724, + "updated_at": 1719492724, + "description": "english collection description", + "icon": "folder", + "parent_id": null, + "help_center_id": 87 + } + } + }, + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_helpCenter.deleteCollection": { + "id": "endpoint_helpCenter.deleteCollection", + "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "namespace": [ + "Help Center" + ], + "displayName": "Delete a collection", + "operationId": "deleteCollection", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "collections" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the collection which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "deleted_collection_object" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "collection Not Found", + "name": "Not Found", + "examples": [ + { + "name": "collection Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/collections/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "182", + "object": "collection", + "deleted": true + } + } + } + ] + }, + "endpoint_helpCenter.retrieveHelpCenter": { + "id": "endpoint_helpCenter.retrieveHelpCenter", + "description": "You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/`.", + "namespace": [ + "Help Center" + ], + "displayName": "Retrieve a Help Center", + "operationId": "retrieveHelpCenter", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_centers" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the collection which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "help_center" + } + }, + "description": "Collection found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Collection not found", + "name": "Not Found", + "examples": [ + { + "name": "Collection not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/help_centers/{id}", + "responseStatusCode": 200, + "name": "Collection found", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "93", + "workspace_id": "this_is_an_id93_that_should_be_at_least_4", + "created_at": 1719492727, + "updated_at": 1719492727, + "identifier": "help-center-1", + "website_turned_on": false, + "display_name": "Intercom Help Center" + } + } + } + ] + }, + "endpoint_helpCenter.listHelpCenters": { + "id": "endpoint_helpCenter.listHelpCenters", + "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", + "namespace": [ + "Help Center" + ], + "displayName": "List all Help Centers", + "operationId": "listHelpCenters", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_center" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "help_centers" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "help_center_list" + } + }, + "description": "Help Centers found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/help_center/help_centers", + "responseStatusCode": 200, + "name": "Help Centers found", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [] + } + } + } + ] + }, + "endpoint_companies.retrieveCompany": { + "id": "endpoint_companies.retrieveCompany", + "description": "You can fetch a single company by passing in `company_id` or `name`.\n\n `https://api.intercom.io/companies?name={name}`\n\n `https://api.intercom.io/companies?company_id={company_id}`\n\nYou can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter.\n\n `https://api.intercom.io/companies?tag_id={tag_id}`\n\n `https://api.intercom.io/companies?segment_id={segment_id}`\n", + "namespace": [ + "Companies" + ], + "displayName": "Retrieve companies", + "operationId": "retrieveCompany", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The `name` of the company to filter by." + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The `company_id` of the company to filter by." + }, + { + "key": "tag_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The `tag_id` of the company to filter by." + }, + { + "key": "segment_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The `segment_id` of the company to filter by." + }, + { + "key": "page", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The page of results to fetch. Defaults to first page" + }, + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "How many results to display per page. Defaults to 15" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company_list" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies", + "responseStatusCode": 200, + "name": "Successful", + "queryParameters": { + "name": "my company", + "company_id": "12345", + "tag_id": "678910", + "segment_id": "98765", + "page": 1, + "per_page": 15 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "remote_companies_scroll_2", + "id": "667d607e8a68186f43bafd26", + "app_id": "this_is_an_id122_that_should_be_at_least_", + "name": "IntercomQATest1", + "remote_created_at": 1719492734, + "created_at": 1719492734, + "updated_at": 1719492734, + "monthly_spend": 0, + "session_count": 0, + "user_count": 4, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 15, + "total_pages": 1 + }, + "total_count": 1 + } + } + } + ] + }, + "endpoint_companies.createOrUpdateCompany": { + "id": "endpoint_companies.createOrUpdateCompany", + "description": "You can create or update a company.\n\nCompanies will be only visible in Intercom when there is at least one associated user.\n\nCompanies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated.\n\n{% admonition type=\"attention\" name=\"Using `company_id`\" %}\n You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company.\n{% /admonition %}\n", + "namespace": [ + "Companies" + ], + "displayName": "Create or Update a company", + "operationId": "createOrUpdateCompany", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_or_update_company_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Bad Request", + "name": "Bad Request", + "examples": [ + { + "name": "Bad Request", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": null, + "errors": [ + { + "code": "bad_request", + "message": "bad 'test' parameter" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies", + "responseStatusCode": 200, + "name": "Successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "company", + "company_id": "company_remote_id", + "id": "667d607c8a68186f43bafd1e", + "app_id": "this_is_an_id116_that_should_be_at_least_", + "name": "my company", + "remote_created_at": 1374138000, + "created_at": 1719492732, + "updated_at": 1719492732, + "monthly_spend": 0, + "session_count": 0, + "user_count": 0, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": { + "creation_source": "api" + } + } + } + }, + { + "path": "/companies", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/companies", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_companies.RetrieveACompanyById": { + "id": "endpoint_companies.RetrieveACompanyById", + "description": "You can fetch a single company.", + "namespace": [ + "Companies" + ], + "displayName": "Retrieve a company by ID", + "operationId": "RetrieveACompanyById", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "test-uuid-replacement" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "company", + "company_id": "1", + "id": "667d60808a68186f43bafd31", + "app_id": "this_is_an_id128_that_should_be_at_least_", + "name": "company1", + "remote_created_at": 1719492736, + "created_at": 1719492736, + "updated_at": 1719492736, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + } + ] + }, + "endpoint_companies.UpdateCompany": { + "id": "endpoint_companies.UpdateCompany", + "description": "You can update a single company using the Intercom provisioned `id`.\n\n{% admonition type=\"attention\" name=\"Using `company_id`\" %}\n When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.\n{% /admonition %}\n", + "namespace": [ + "Companies" + ], + "displayName": "Update a company", + "operationId": "UpdateCompany", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "test-uuid-replacement" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "company", + "company_id": "1", + "id": "667d60828a68186f43bafd3b", + "app_id": "this_is_an_id134_that_should_be_at_least_", + "name": "company2", + "remote_created_at": 1719492738, + "created_at": 1719492738, + "updated_at": 1719492738, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + } + ] + }, + "endpoint_companies.deleteCompany": { + "id": "endpoint_companies.deleteCompany", + "description": "You can delete a single company.", + "namespace": [ + "Companies" + ], + "displayName": "Delete a company", + "operationId": "deleteCompany", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "deleted_company_object" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "test-uuid-replacement" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "667d60848a68186f43bafd45", + "object": "company", + "deleted": true + } + } + } + ] + }, + "endpoint_companiesContacts.ListAttachedContacts": { + "id": "endpoint_companiesContacts.ListAttachedContacts", + "description": "You can fetch a list of all contacts that belong to a company.", + "namespace": [ + "Companies", + "Contacts" + ], + "displayName": "List attached contacts", + "operationId": "ListAttachedContacts", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company_attached_contacts" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/{id}/contacts", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "test-uuid-replacement" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [], + "total_count": 0, + "pages": { + "type": "pages", + "page": 1, + "per_page": 50, + "total_pages": 0 + } + } + } + } + ] + }, + "endpoint_companies.ListAttachedSegmentsForCompanies": { + "id": "endpoint_companies.ListAttachedSegmentsForCompanies", + "description": "You can fetch a list of all segments that belong to a company.", + "namespace": [ + "Companies" + ], + "displayName": "List attached segments for companies", + "operationId": "ListAttachedSegmentsForCompanies", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "segments" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company_attached_segments" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/{id}/segments", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "test-uuid-replacement" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [] + } + } + } + ] + }, + "endpoint_companies.listAllCompanies": { + "id": "endpoint_companies.listAllCompanies", + "description": "You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first.\n\nNote that the API does not include companies who have no associated users in list responses.\n\nWhen using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies).\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "namespace": [ + "Companies" + ], + "displayName": "List all companies", + "operationId": "listAllCompanies", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "list" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "page", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The page of results to fetch. Defaults to first page" + }, + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "How many results to return per page. Defaults to 15" + }, + { + "key": "order", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company_list" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/list", + "responseStatusCode": 200, + "name": "Successful", + "queryParameters": { + "page": 1, + "per_page": 15, + "order": "desc" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "remote_companies_scroll_2", + "id": "667d608a8a68186f43bafd61", + "app_id": "this_is_an_id158_that_should_be_at_least_", + "name": "IntercomQATest1", + "remote_created_at": 1719492746, + "created_at": 1719492746, + "updated_at": 1719492746, + "monthly_spend": 0, + "session_count": 0, + "user_count": 4, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 15, + "total_pages": 1 + }, + "total_count": 1 + } + } + } + ] + }, + "endpoint_companies.scrollOverAllCompanies": { + "id": "endpoint_companies.scrollOverAllCompanies", + "description": " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset.\n\n- Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.\n- If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail\n- If the end of the scroll is reached, \"companies\" will be empty and the scroll parameter will expire\n\n{% admonition type=\"info\" name=\"Scroll Parameter\" %}\n You can get the first page of companies by simply sending a GET request to the scroll endpoint.\n For subsequent requests you will need to use the scroll parameter from the response.\n{% /admonition %}\n{% admonition type=\"danger\" name=\"Scroll network timeouts\" %}\n Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message:\n \"Request failed due to an internal network error. Please restart the scroll operation.\"\n If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll.\n{% /admonition %}\n", + "namespace": [ + "Companies" + ], + "displayName": "Scroll over all companies", + "operationId": "scrollOverAllCompanies", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "scroll" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "scroll_param", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company_scroll" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/companies/scroll", + "responseStatusCode": 200, + "name": "Successful", + "queryParameters": { + "scroll_param": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "remote_companies_scroll_2", + "id": "667d608b8a68186f43bafd67", + "app_id": "this_is_an_id162_that_should_be_at_least_", + "name": "IntercomQATest1", + "remote_created_at": 1719492747, + "created_at": 1719492747, + "updated_at": 1719492747, + "monthly_spend": 0, + "session_count": 0, + "user_count": 4, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": null, + "total_count": null, + "scroll_param": "test-uuid-replacement" + } + } + } + ] + }, + "endpoint_contactsCompanies.listCompaniesForAContact": { + "id": "endpoint_contactsCompanies.listCompaniesForAContact", + "description": "You can fetch a list of companies that are associated to a contact.", + "namespace": [ + "Contacts", + "Companies" + ], + "displayName": "List attached companies for contact", + "operationId": "listCompaniesForAContact", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_attached_companies" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}/companies", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "1", + "id": "667d60938a68186f43bafd91", + "app_id": "this_is_an_id182_that_should_be_at_least_", + "name": "company12", + "remote_created_at": 1719492755, + "created_at": 1719492755, + "updated_at": 1719492755, + "last_request_at": 1719319955, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 50, + "total_pages": 1 + }, + "total_count": 1 + } + } + } + ] + }, + "endpoint_companiesContacts.attachContactToACompany": { + "id": "endpoint_companiesContacts.attachContactToACompany", + "description": "You can attach a company to a single contact.", + "namespace": [ + "Companies", + "Contacts" + ], + "displayName": "Attach a Contact to a Company", + "operationId": "attachContactToACompany", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Bad Request", + "name": "Bad Request", + "examples": [ + { + "name": "Bad Request", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_not_found", + "message": "company not specified" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Company Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}/companies", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "company", + "company_id": "1", + "id": "667d608d8a68186f43bafd70", + "app_id": "this_is_an_id166_that_should_be_at_least_", + "name": "company6", + "remote_created_at": 1719492749, + "created_at": 1719492749, + "updated_at": 1719492749, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + }, + { + "path": "/contacts/{id}/companies", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": "667d608d8a68186f43bafd70" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{id}/companies", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": "123" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_companiesContacts.detachContactFromACompany": { + "id": "endpoint_companiesContacts.detachContactFromACompany", + "description": "You can detach a company from a single contact.", + "namespace": [ + "Companies", + "Contacts" + ], + "displayName": "Detach a contact from a company", + "operationId": "detachContactFromACompany", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "companies" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Company Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + }, + { + "name": "Contact Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/companies/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "contact_id": "58a430d35458202d41b1e65b", + "id": "58a430d35458202d41b1e65b" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "company", + "company_id": "1", + "id": "667d60918a68186f43bafd80", + "app_id": "this_is_an_id174_that_should_be_at_least_", + "name": "company8", + "remote_created_at": 1719492753, + "created_at": 1719492753, + "updated_at": 1719492753, + "monthly_spend": 0, + "session_count": 0, + "user_count": 0, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + } + ] + }, + "endpoint_notesContacts.listNotes": { + "id": "endpoint_notesContacts.listNotes", + "description": "You can fetch a list of notes that are associated to a contact.", + "namespace": [ + "Notes", + "Contacts" + ], + "displayName": "List all notes", + "operationId": "listNotes", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "notes" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier of a contact." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "note_list" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}/notes", + "responseStatusCode": 200, + "name": "Successful response", + "pathParameters": { + "id": 0 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "note", + "id": "29", + "created_at": 1718887958, + "contact": { + "type": "contact", + "id": "667d60968a68186f43bafd9c" + }, + "author": { + "type": "admin", + "id": "991267491", + "name": "Ciaran101 Lee", + "email": "admin101@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + }, + { + "type": "note", + "id": "28", + "created_at": 1718801558, + "contact": { + "type": "contact", + "id": "667d60968a68186f43bafd9c" + }, + "author": { + "type": "admin", + "id": "991267491", + "name": "Ciaran101 Lee", + "email": "admin101@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + }, + { + "type": "note", + "id": "27", + "created_at": 1718801558, + "contact": { + "type": "contact", + "id": "667d60968a68186f43bafd9c" + }, + "author": { + "type": "admin", + "id": "991267491", + "name": "Ciaran101 Lee", + "email": "admin101@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + } + ], + "total_count": 3, + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 50, + "total_pages": 1 + } + } + } + } + ] + }, + "endpoint_notesContacts.createNote": { + "id": "endpoint_notesContacts.createNote", + "description": "You can add a note to a single contact.", + "namespace": [ + "Notes", + "Contacts" + ], + "displayName": "Create a note", + "operationId": "createNote", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "notes" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier of a given contact." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The text of the note." + }, + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier of a given contact." + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier of a given admin." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "note" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Admin not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + }, + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}/notes", + "responseStatusCode": 200, + "name": "Successful response", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "note", + "id": "34", + "created_at": 1719492759, + "contact": { + "type": "contact", + "id": "667d60978a68186f43bafd9e" + }, + "author": { + "type": "admin", + "id": "991267493", + "name": "Ciaran103 Lee", + "email": "admin103@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

Hello

" + } + } + }, + { + "path": "/contacts/{id}/notes", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "contact_id": "667d60978a68186f43bafd9e", + "admin_id": 991267493, + "body": "Hello" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{id}/notes", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "contact_id": "667d60988a68186f43bafd9f", + "admin_id": 123, + "body": "Hello" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{id}/notes", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "contact_id": 123, + "admin_id": 991267495, + "body": "Hello" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_contactsSegments.listSegmentsForAContact": { + "id": "endpoint_contactsSegments.listSegmentsForAContact", + "description": "You can fetch a list of segments that are associated to a contact.", + "namespace": [ + "Contacts", + "Segments" + ], + "displayName": "List attached segments for contact", + "operationId": "listSegmentsForAContact", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "segments" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_segments" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/segments", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "segment", + "id": "667d60998a68186f43bafda1", + "name": "segment", + "created_at": 1719492761, + "updated_at": 1719492761, + "person_type": "user" + } + ] + } + } + } + ] + }, + "endpoint_contactsSubscriptionTypes.listSubscriptionsForAContact": { + "id": "endpoint_contactsSubscriptionTypes.listSubscriptionsForAContact", + "description": "You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type.\nThis will return a list of Subscription Type objects that the contact is associated with.\n\nThe data property will show a combined list of:\n\n 1.Opt-out subscription types that the user has opted-out from.\n 2.Opt-in subscription types that the user has opted-in to receiving.\n", + "namespace": [ + "Contacts", + "Subscription Types" + ], + "displayName": "List subscriptions for a contact", + "operationId": "listSubscriptionsForAContact", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "subscriptions" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "subscription_type_list" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/subscriptions", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "subscription", + "id": "93", + "state": "live", + "consent_type": "opt_out", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "email" + ] + }, + { + "type": "subscription", + "id": "95", + "state": "live", + "consent_type": "opt_in", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "sms_message" + ] + } + ] + } + } + } + ] + }, + "endpoint_subscriptionTypesContacts.attachSubscriptionTypeToContact": { + "id": "endpoint_subscriptionTypesContacts.attachSubscriptionTypeToContact", + "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", + "namespace": [ + "Subscription Types", + "Contacts" + ], + "displayName": "Add subscription to a contact", + "operationId": "attachSubscriptionTypeToContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "subscriptions" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the subscription which is given by Intercom" + }, + { + "key": "consent_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The consent_type of a subscription, opt_out or opt_in." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "subscription_type" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Resource not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + }, + { + "name": "Resource not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/subscriptions", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "subscription", + "id": "108", + "state": "live", + "consent_type": "opt_in", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "sms_message" + ] + } + } + }, + { + "path": "/contacts/{contact_id}/subscriptions", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 108, + "consent_type": "opt_in" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{contact_id}/subscriptions", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 112, + "consent_type": "opt_in" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{contact_id}/subscriptions", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": "invalid_id", + "consent_type": "opt_in" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_subscriptionTypesContacts.detachSubscriptionTypeToContact": { + "id": "endpoint_subscriptionTypesContacts.detachSubscriptionTypeToContact", + "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "namespace": [ + "Subscription Types", + "Contacts" + ], + "displayName": "Remove subscription from a contact", + "operationId": "detachSubscriptionTypeToContact", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "subscriptions" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the subscription type which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "subscription_type" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Resource not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + }, + { + "name": "Resource not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/subscriptions/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965", + "id": "37846" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "subscription", + "id": "124", + "state": "live", + "consent_type": "opt_in", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "sms_message" + ] + } + } + } + ] + }, + "endpoint_contactsTags.listTagsForAContact": { + "id": "endpoint_contactsTags.listTagsForAContact", + "description": "You can fetch a list of all tags that are attached to a specific contact.", + "namespace": [ + "Contacts", + "Tags" + ], + "displayName": "List tags attached to a contact", + "operationId": "listTagsForAContact", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "tag", + "id": "93", + "name": "Manual tag" + } + ] + } + } + } + ] + }, + "endpoint_tagsContacts.attachTagToContact": { + "id": "endpoint_tagsContacts.attachTagToContact", + "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "namespace": [ + "Tags", + "Contacts" + ], + "displayName": "Add tag to a contact", + "operationId": "attachTagToContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the tag which is given by Intercom" + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + }, + { + "name": "Tag not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "94", + "name": "Manual tag" + } + } + }, + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 94 + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "94", + "name": "Manual tag" + } + } + }, + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 94 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 95 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/contacts/{contact_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": "123" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tagsContacts.detachTagFromContact": { + "id": "endpoint_tagsContacts.detachTagFromContact", + "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "namespace": [ + "Tags", + "Contacts" + ], + "displayName": "Remove tag from a contact", + "operationId": "detachTagFromContact", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the tag which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag not found", + "name": "Not Found", + "examples": [ + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + }, + { + "name": "Tag not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{contact_id}/tags/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "contact_id": "63a07ddf05a32042dffac965", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "97", + "name": "Manual tag" + } + } + } + ] + }, + "endpoint_contacts.ShowContact": { + "id": "endpoint_contacts.ShowContact", + "description": "You can fetch the details of a single contact.", + "namespace": [ + "Contacts" + ], + "displayName": "Get a contact", + "operationId": "ShowContact", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60a98a68186f43bafdb9", + "workspace_id": "this_is_an_id252_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joe@bloggs.com", + "phone": null, + "name": "Joe Bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492777, + "updated_at": 1719492777, + "signed_up_at": 1719492777, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + } + ] + }, + "endpoint_contacts.UpdateContact": { + "id": "endpoint_contacts.UpdateContact", + "description": "You can update an existing contact (ie. user or lead).", + "namespace": [ + "Contacts" + ], + "displayName": "Update a contact", + "operationId": "UpdateContact", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60a88a68186f43bafdb8", + "workspace_id": "this_is_an_id248_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joebloggs@intercom.io", + "phone": null, + "name": "joe bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492776, + "updated_at": 1719492776, + "signed_up_at": 1719492776, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "email": "joebloggs@intercom.io", + "name": "joe bloggs" + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60a88a68186f43bafdb8", + "workspace_id": "this_is_an_id248_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joebloggs@intercom.io", + "phone": null, + "name": "joe bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492776, + "updated_at": 1719492776, + "signed_up_at": 1719492776, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "email": "joebloggs@intercom.io", + "name": "joe bloggs" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_contacts.DeleteContact": { + "id": "endpoint_contacts.DeleteContact", + "description": "You can delete a single contact.", + "namespace": [ + "Contacts" + ], + "displayName": "Delete a contact", + "operationId": "DeleteContact", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_deleted" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "667d60aa8a68186f43bafdba", + "external_id": "70", + "type": "contact", + "deleted": true + } + } + } + ] + }, + "endpoint_contacts.MergeContact": { + "id": "endpoint_contacts.MergeContact", + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "namespace": [ + "Contacts" + ], + "displayName": "Merge a lead and a user", + "operationId": "MergeContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "merge" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "merge_contacts_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/merge", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60ac8a68186f43bafdbc", + "workspace_id": "this_is_an_id260_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joe@bloggs.com", + "phone": null, + "name": "Joe Bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492780, + "updated_at": 1719492780, + "signed_up_at": 1719492780, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts/merge", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60ac8a68186f43bafdbc", + "workspace_id": "this_is_an_id260_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joe@bloggs.com", + "phone": null, + "name": "Joe Bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492780, + "updated_at": 1719492780, + "signed_up_at": 1719492780, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts/merge", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_contacts.SearchContacts": { + "id": "endpoint_contacts.SearchContacts", + "description": "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for contacts.\n\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n### Contact Creation Delay\n\nIf a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n* There's a limit of max 2 nested filters\n* There's a limit of max 15 filters for each AND or OR group\n\n### Searching for Timestamp Fields\n\nAll timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second.\nFor example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards.\nIf you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM).\nThis behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.\n\n### Accepted Fields\n\nMost key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\n\n| Field | Type |\n| ---------------------------------- | ------------------------------ |\n| id | String |\n| role | String
Accepts user or lead |\n| name | String |\n| avatar | String |\n| owner_id | Integer |\n| email | String |\n| email_domain | String |\n| phone | String |\n| formatted_phone | String |\n| external_id | String |\n| created_at | Date (UNIX Timestamp) |\n| signed_up_at | Date (UNIX Timestamp) |\n| updated_at | Date (UNIX Timestamp) |\n| last_seen_at | Date (UNIX Timestamp) |\n| last_contacted_at | Date (UNIX Timestamp) |\n| last_replied_at | Date (UNIX Timestamp) |\n| last_email_opened_at | Date (UNIX Timestamp) |\n| last_email_clicked_at | Date (UNIX Timestamp) |\n| language_override | String |\n| browser | String |\n| browser_language | String |\n| os | String |\n| location.country | String |\n| location.region | String |\n| location.city | String |\n| unsubscribed_from_emails | Boolean |\n| marked_email_as_spam | Boolean |\n| has_hard_bounced | Boolean |\n| ios_last_seen_at | Date (UNIX Timestamp) |\n| ios_app_version | String |\n| ios_device | String |\n| ios_app_device | String |\n| ios_os_version | String |\n| ios_app_name | String |\n| ios_sdk_version | String |\n| android_last_seen_at | Date (UNIX Timestamp) |\n| android_app_version | String |\n| android_device | String |\n| android_app_name | String |\n| andoid_sdk_version | String |\n| segment_id | String |\n| tag_id | String |\n| custom_attributes.{attribute_name} | String |\n\n### Accepted Operators\n\n{% admonition type=\"attention\" name=\"Searching based on `created_at`\" %}\n You cannot use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :------------------------------- | :--------------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In
Shortcut for `OR` queries
Values must be in Array |\n| NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array |\n| > | Integer
Date (UNIX Timestamp) | Greater than |\n| < | Integer
Date (UNIX Timestamp) | Lower than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "namespace": [ + "Contacts" + ], + "displayName": "Search contacts", + "operationId": "SearchContacts", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "search" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "search_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [], + "total_count": 0, + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 0 + } + } + } + }, + { + "path": "/contacts/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [], + "total_count": 0, + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 0 + } + } + } + }, + { + "path": "/contacts/search", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_contacts.ListContacts": { + "id": "endpoint_contacts.ListContacts", + "description": "You can fetch a list of all contacts (ie. users or leads) in your workspace.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "namespace": [ + "Contacts" + ], + "displayName": "List all contacts", + "operationId": "ListContacts", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [], + "total_count": 0, + "pages": { + "type": "pages", + "page": 1, + "per_page": 10, + "total_pages": 0 + } + } + } + } + ] + }, + "endpoint_contacts.CreateContact": { + "id": "endpoint_contacts.CreateContact", + "description": "You can create a new contact (ie. user or lead).", + "namespace": [ + "Contacts" + ], + "displayName": "Create contact", + "operationId": "CreateContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/contacts", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60b08a68186f43bafdbf", + "workspace_id": "this_is_an_id272_that_should_be_at_least_", + "external_id": null, + "role": "user", + "email": "joebloggs@intercom.io", + "phone": null, + "name": null, + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492784, + "updated_at": 1719492784, + "signed_up_at": null, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "email": "joebloggs@intercom.io" + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d60b08a68186f43bafdbf", + "workspace_id": "this_is_an_id272_that_should_be_at_least_", + "external_id": null, + "role": "user", + "email": "joebloggs@intercom.io", + "phone": null, + "name": null, + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492784, + "updated_at": 1719492784, + "signed_up_at": null, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/contacts", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "email": "joebloggs@intercom.io" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_contacts.ArchiveContact": { + "id": "endpoint_contacts.ArchiveContact", + "description": "You can archive a single contact.", + "namespace": [ + "Contacts" + ], + "displayName": "Archive contact", + "operationId": "ArchiveContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "archive" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_archived" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/contacts/{id}/archive", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "667d60b18a68186f43bafdc0", + "external_id": "70", + "type": "contact", + "archived": true + } + } + } + ] + }, + "endpoint_contacts.UnarchiveContact": { + "id": "endpoint_contacts.UnarchiveContact", + "description": "You can unarchive a single contact.", + "namespace": [ + "Contacts" + ], + "displayName": "Unarchive contact", + "operationId": "UnarchiveContact", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "contacts" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "unarchive" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_unarchived" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/contacts/{id}/unarchive", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "63a07ddf05a32042dffac965" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "667d60b28a68186f43bafdc1", + "external_id": "70", + "type": "contact", + "archived": false + } + } + } + ] + }, + "endpoint_tagsConversations.attachTagToConversation": { + "id": "endpoint_tagsConversations.attachTagToConversation", + "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "namespace": [ + "Tags", + "Conversations" + ], + "displayName": "Add tag to a conversation", + "operationId": "attachTagToConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "conversation_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "conversation_id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the tag which is given by Intercom" + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the admin which is given by Intercom." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Conversation not found", + "name": "Not Found", + "examples": [ + { + "name": "Conversation not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Conversation not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{conversation_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "conversation_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "99", + "name": "Manual tag" + } + } + }, + { + "path": "/conversations/{conversation_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "conversation_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 99, + "admin_id": 991267526 + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "99", + "name": "Manual tag" + } + } + }, + { + "path": "/conversations/{conversation_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 99, + "admin_id": 991267526 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 100, + "admin_id": 991267528 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tagsConversations.detachTagFromConversation": { + "id": "endpoint_tagsConversations.detachTagFromConversation", + "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "namespace": [ + "Tags", + "Conversations" + ], + "displayName": "Remove tag from a conversation", + "operationId": "detachTagFromConversation", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "conversation_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "conversation_id" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the admin which is given by Intercom." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag not found", + "name": "Not Found", + "examples": [ + { + "name": "Conversation not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Conversation not found" + } + ] + } + } + }, + { + "name": "Tag not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "tag_not_found", + "message": "Tag not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{conversation_id}/tags/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "conversation_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "102", + "name": "Manual tag" + } + } + }, + { + "path": "/conversations/{conversation_id}/tags/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "conversation_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267530 + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "102", + "name": "Manual tag" + } + } + }, + { + "path": "/conversations/{conversation_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267530 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267532 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267533 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.listConversations": { + "id": "endpoint_conversations.listConversations", + "description": "You can fetch a list of all conversations.\n\nYou can optionally request the result page size and the cursor to start after to fetch the result.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "namespace": [ + "Conversations" + ], + "displayName": "List all conversations", + "operationId": "listConversations", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer", + "maximum": 150, + "default": 20 + } + } + } + } + }, + "description": "How many results per page" + }, + { + "key": "starting_after", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "String used to get the next page of conversations." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "paginated_response" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations", + "responseStatusCode": 200, + "name": "successful", + "queryParameters": { + "per_page": 20, + "starting_after": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 20, + "total_pages": 1 + }, + "total_count": 1, + "conversations": [ + { + "type": "conversation", + "id": "335", + "created_at": 1719492795, + "updated_at": 1719492795, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918241", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267536", + "name": "Ciaran143 Lee", + "email": "admin143@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60bb8a68186f43bafdc5", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false + } + ] + } + } + } + ] + }, + "endpoint_conversations.createConversation": { + "id": "endpoint_conversations.createConversation", + "description": "You can create a conversation that has been initiated by a contact (ie. user or lead).\nThe conversation can be an in-app message only.\n\n{% admonition type=\"info\" name=\"Sending for visitors\" %}\nYou can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`.\nThis visitor will be automatically converted to a contact with a lead role once the conversation is created.\n{% /admonition %}\n\nThis will return the Message model that has been created.\n\n", + "namespace": [ + "Conversations" + ], + "displayName": "Creates a conversation", + "operationId": "createConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "message" + } + }, + "description": "conversation created" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Contact Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations", + "responseStatusCode": 200, + "name": "conversation created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "user_message", + "id": "403918251", + "created_at": 1719492819, + "body": "Hello there", + "message_type": "inapp", + "conversation_id": "363" + } + } + }, + { + "path": "/conversations", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.retrieveConversation": { + "id": "endpoint_conversations.retrieveConversation", + "description": "\nYou can fetch the details of a single conversation.\n\nThis will return a single Conversation model with all its conversation parts.\n\n{% admonition type=\"warning\" name=\"Hard limit of 500 parts\" %}\nThe maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts.\n{% /admonition %}\n\nFor AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671).\n", + "namespace": [ + "Conversations" + ], + "displayName": "Retrieve a conversation", + "operationId": "retrieveConversation", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the conversation to target" + } + ], + "queryParameters": [ + { + "key": "display_as", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "conversation found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}", + "responseStatusCode": 200, + "name": "conversation found", + "pathParameters": { + "id": 123 + }, + "queryParameters": { + "display_as": "plaintext" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "367", + "created_at": 1719492825, + "updated_at": 1719492825, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918255", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267553", + "name": "Ciaran153 Lee", + "email": "admin153@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60d88a68186f43bafde1", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [], + "total_count": 0 + } + } + } + } + ] + }, + "endpoint_conversations.updateConversation": { + "id": "endpoint_conversations.updateConversation", + "description": "\nYou can update an existing conversation.\n\n{% admonition type=\"info\" name=\"Replying and other actions\" %}\nIf you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints.\n{% /admonition %}\n\n", + "namespace": [ + "Conversations" + ], + "displayName": "Update a conversation", + "operationId": "updateConversation", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the conversation to target" + } + ], + "queryParameters": [ + { + "key": "display_as", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Set to plaintext to retrieve conversation messages in plain text." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "conversation found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}", + "responseStatusCode": 200, + "name": "conversation found", + "pathParameters": { + "id": 123 + }, + "queryParameters": { + "display_as": "plaintext" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "371", + "created_at": 1719492832, + "updated_at": 1719492834, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918259", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267561", + "name": "Ciaran157 Lee", + "email": "admin157@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60e08a68186f43bafde5", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": true, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": { + "issue_type": "Billing", + "priority": "High" + }, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "96", + "part_type": "conversation_attribute_updated_by_admin", + "body": null, + "created_at": 1719492834, + "updated_at": 1719492834, + "notified_at": 1719492834, + "assigned_to": null, + "author": { + "id": "991267562", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "external_id": null, + "redacted": false + }, + { + "type": "conversation_part", + "id": "97", + "part_type": "conversation_attribute_updated_by_admin", + "body": null, + "created_at": 1719492834, + "updated_at": 1719492834, + "notified_at": 1719492834, + "assigned_to": null, + "author": { + "id": "991267562", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 2 + } + } + } + }, + { + "path": "/conversations/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "queryParameters": { + "display_as": "plaintext" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "queryParameters": { + "display_as": "plaintext" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.searchConversations": { + "id": "endpoint_conversations.searchConversations", + "description": "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for conversations.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the The conversation model is searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\n\n| Field | Type |\n| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. |\n| source.id | String |\n| source.delivered_as | String |\n| source.subject | String |\n| source.body | String |\n| source.author.id | String |\n| source.author.type | String |\n| source.author.name | String |\n| source.author.email | String |\n| source.url | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | String |\n| team_assignee_id | String |\n| channel_initiated | String |\n| open | Boolean |\n| read | Boolean |\n| state | String |\n| waiting_since | Date (UNIX timestamp) |\n| snoozed_until | Date (UNIX timestamp) |\n| tag_ids | String |\n| priority | String |\n| statistics.time_to_assignment | Integer |\n| statistics.time_to_admin_reply | Integer |\n| statistics.time_to_first_close | Integer |\n| statistics.time_to_last_close | Integer |\n| statistics.median_time_to_reply | Integer |\n| statistics.first_contact_reply_at | Date (UNIX timestamp) |\n| statistics.first_assignment_at | Date (UNIX timestamp) |\n| statistics.first_admin_reply_at | Date (UNIX timestamp) |\n| statistics.first_close_at | Date (UNIX timestamp) |\n| statistics.last_assignment_at | Date (UNIX timestamp) |\n| statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) |\n| statistics.last_contact_reply_at | Date (UNIX timestamp) |\n| statistics.last_admin_reply_at | Date (UNIX timestamp) |\n| statistics.last_close_at | Date (UNIX timestamp) |\n| statistics.last_closed_by_id | String |\n| statistics.count_reopens | Integer |\n| statistics.count_assignments | Integer |\n| statistics.count_conversation_parts | Integer |\n| conversation_rating.requested_at | Date (UNIX timestamp) |\n| conversation_rating.replied_at | Date (UNIX timestamp) |\n| conversation_rating.score | Integer |\n| conversation_rating.remark | String |\n| conversation_rating.contact_id | String |\n| conversation_rating.admin_d | String |\n| ai_agent_participated | Boolean |\n| ai_agent.resolution_state | String |\n| ai_agent.last_answer_type | String |\n| ai_agent.rating | Integer |\n| ai_agent.rating_remark | String |\n| ai_agent.source_type | String |\n| ai_agent.source_title | String |\n\n### Accepted Operators\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "namespace": [ + "Conversations" + ], + "displayName": "Search conversations", + "operationId": "searchConversations", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "search" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "search_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_list" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/conversations/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 1 + }, + "total_count": 1, + "conversations": [ + { + "type": "conversation", + "id": "378", + "created_at": 1719492843, + "updated_at": 1719492843, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918266", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267591", + "name": "Ciaran180 Lee", + "email": "admin180@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60ea8a68186f43bafdec", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false + } + ] + } + } + }, + { + "path": "/conversations/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 1 + }, + "total_count": 1, + "conversations": [ + { + "type": "conversation", + "id": "378", + "created_at": 1719492843, + "updated_at": 1719492843, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918266", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267591", + "name": "Ciaran180 Lee", + "email": "admin180@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60ea8a68186f43bafdec", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false + } + ] + } + } + }, + { + "path": "/conversations/search", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.replyConversation": { + "id": "endpoint_conversations.replyConversation", + "description": "You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.", + "namespace": [ + "Conversations" + ], + "displayName": "Reply to a conversation", + "operationId": "replyConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "reply" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom provisioned identifier for the conversation or the string \"last\" to reply to the last part of the conversation" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "reply_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "User last conversation reply" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "name": "User reply", + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "387", + "created_at": 1719492849, + "updated_at": 1719492850, + "waiting_since": 1719492850, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918269", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267594", + "name": "Ciaran182 Lee", + "email": "admin182@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60f18a68186f43bafdf4", + "external_id": "70" + } + ] + }, + "first_contact_reply": { + "created_at": 1719492850, + "type": "conversation", + "url": null + }, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "99", + "part_type": "open", + "body": "

Thanks again :)

", + "created_at": 1719492850, + "updated_at": 1719492850, + "notified_at": 1719492850, + "assigned_to": null, + "author": { + "id": "667d60f18a68186f43bafdf4", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "name": "Admin note reply", + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "388", + "created_at": 1719492852, + "updated_at": 1719492853, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918270", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267596", + "name": "Ciaran183 Lee", + "email": "admin183@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60f38a68186f43bafdf5", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "100", + "part_type": "note", + "body": "

An Unordered HTML List

\n
    \n
  • Coffee
    • \n
  • Tea
    • \n
  • Milk
    • \n
\n

An Ordered HTML List

\n
    \n
  1. Coffee
    2. \n
  2. Tea
    3. \n
  3. Milk
    4. \n
", + "created_at": 1719492853, + "updated_at": 1719492853, + "notified_at": 1719492853, + "assigned_to": null, + "author": { + "id": "991267596", + "type": "admin", + "name": "Ciaran183 Lee", + "email": "admin183@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "name": "User last conversation reply", + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "390", + "created_at": 1719492855, + "updated_at": 1719492856, + "waiting_since": 1719492856, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918272", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267600", + "name": "Ciaran185 Lee", + "email": "admin185@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60f78a68186f43bafdf7", + "external_id": "70" + } + ] + }, + "first_contact_reply": { + "created_at": 1719492856, + "type": "conversation", + "url": null + }, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "101", + "part_type": "open", + "body": "

Thanks again :)

", + "created_at": 1719492856, + "updated_at": 1719492856, + "notified_at": 1719492856, + "assigned_to": null, + "author": { + "id": "667d60f78a68186f43bafdf7", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123 or \"last\"" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.manageConversation": { + "id": "endpoint_conversations.manageConversation", + "description": "For managing conversations you can:\n- Close a conversation\n- Snooze a conversation to reopen on a future date\n- Open a conversation which is `snoozed` or `closed`\n- Assign a conversation to an admin and/or team.\n", + "namespace": [ + "Conversations" + ], + "displayName": "Manage a conversation", + "operationId": "manageConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "parts" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the conversation as given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "Assign a conversation" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "name": "Close a conversation", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "394", + "created_at": 1719492862, + "updated_at": 1719492862, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918276", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267608", + "name": "Ciaran189 Lee", + "email": "admin189@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60fd8a68186f43bafdfb", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "102", + "part_type": "close", + "body": "

Goodbye :)

", + "created_at": 1719492862, + "updated_at": 1719492862, + "notified_at": 1719492862, + "assigned_to": null, + "author": { + "id": "991267608", + "type": "admin", + "name": "Ciaran189 Lee", + "email": "admin189@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "name": "Snooze a conversation", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "395", + "created_at": 1719492864, + "updated_at": 1719492864, + "waiting_since": null, + "snoozed_until": 1719496464, + "source": { + "type": "conversation", + "id": "403918277", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267610", + "name": "Ciaran190 Lee", + "email": "admin190@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60ff8a68186f43bafdfc", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "snoozed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "103", + "part_type": "snoozed", + "body": null, + "created_at": 1719492864, + "updated_at": 1719492864, + "notified_at": 1719492864, + "assigned_to": null, + "author": { + "id": "991267610", + "type": "admin", + "name": "Ciaran190 Lee", + "email": "admin190@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "name": "Open a conversation", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "400", + "created_at": 1719492863, + "updated_at": 1719492873, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918278", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267612", + "name": "Ciaran191 Lee", + "email": "admin191@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61038a68186f43bafe01", + "external_id": "74" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": true, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": "", + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "105", + "part_type": "open", + "body": null, + "created_at": 1719492873, + "updated_at": 1719492873, + "notified_at": 1719492873, + "assigned_to": null, + "author": { + "id": "991267612", + "type": "admin", + "name": "Ciaran191 Lee", + "email": "admin191@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "name": "Assign a conversation", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "405", + "created_at": 1719492874, + "updated_at": 1719492875, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918281", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267615", + "name": "Ciaran193 Lee", + "email": "admin193@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d610a8a68186f43bafe05", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": 991267615, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "106", + "part_type": "assign_and_reopen", + "body": null, + "created_at": 1719492875, + "updated_at": 1719492875, + "notified_at": 1719492875, + "assigned_to": { + "type": "admin", + "id": "991267615" + }, + "author": { + "id": "991267615", + "type": "admin", + "name": "Ciaran193 Lee", + "email": "admin193@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "close", + "type": "admin", + "admin_id": 991267608, + "body": "Goodbye :)" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "snoozed", + "admin_id": 991267610, + "snoozed_until": 1719496464 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "open", + "admin_id": 991267612 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "assignment", + "type": "admin", + "admin_id": 991267615, + "assignee_id": 991267615 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/parts", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "close", + "type": "admin", + "admin_id": 991267617, + "body": "Goodbye :)" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.autoAssignConversation": { + "id": "endpoint_conversations.autoAssignConversation", + "description": "You can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"attention\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", + "namespace": [ + "Conversations" + ], + "displayName": "Run Assignment Rules on a conversation", + "operationId": "autoAssignConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "run_assignment_rules" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the conversation as given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "Assign a conversation using assignment rules" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}/run_assignment_rules", + "responseStatusCode": 200, + "name": "Assign a conversation using assignment rules", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "409", + "created_at": 1719492880, + "updated_at": 1719492881, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918285", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267623", + "name": "Ciaran197 Lee", + "email": "admin197@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61108a68186f43bafe09", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "107", + "part_type": "default_assignment", + "body": null, + "created_at": 1719492881, + "updated_at": 1719492881, + "notified_at": 1719492881, + "assigned_to": { + "type": "nobody_admin", + "id": null + }, + "author": { + "id": "991267624", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id364_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + } + ] + }, + "endpoint_conversations.attachContactToConversation": { + "id": "endpoint_conversations.attachContactToConversation", + "description": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.\n\n{% admonition type=\"attention\" name=\"Contacts without an email\" %}\nIf you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.\n{% /admonition %}\n\n", + "namespace": [ + "Conversations" + ], + "displayName": "Attach a contact to a conversation", + "operationId": "attachContactToConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "customers" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the conversation as given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "attach_contact_to_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "Attach a contact to a conversation" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}/customers", + "responseStatusCode": 200, + "name": "Attach a contact to a conversation", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "customers": [ + { + "type": "user", + "id": "667d61168a68186f43bafe0d" + } + ] + } + } + }, + { + "path": "/conversations/{id}/customers", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/customers", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.detachContactFromConversation": { + "id": "endpoint_conversations.detachContactFromConversation", + "description": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.\n\n{% admonition type=\"attention\" name=\"Contacts without an email\" %}\nIf you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.\n{% /admonition %}\n\n", + "namespace": [ + "Conversations" + ], + "displayName": "Detach a contact from a group conversation", + "operationId": "detachContactFromConversation", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "conversation_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "customers" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "contact_id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the conversation as given by Intercom." + }, + { + "key": "contact_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "detach_contact_from_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "Detach a contact from a group conversation" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Contact not found", + "name": "Not Found", + "examples": [ + { + "name": "Conversation not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + }, + { + "name": "Contact not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Last customer", + "name": "Unprocessable Entity", + "examples": [ + { + "name": "Last customer", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Removing the last customer is not allowed" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "responseStatusCode": 200, + "name": "Detach a contact from a group conversation", + "pathParameters": { + "conversation_id": "123", + "contact_id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "customers": [ + { + "type": "user", + "id": "667d61228a68186f43bafe19" + } + ] + } + } + }, + { + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "123", + "contact_id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "123", + "contact_id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "123", + "contact_id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "responseStatusCode": 200, + "pathParameters": { + "conversation_id": "123", + "contact_id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.redactConversation": { + "id": "endpoint_conversations.redactConversation", + "description": "You can redact a conversation part or the source message of a conversation (as seen in the source object).\n\n{% admonition type=\"info\" name=\"Redacting parts and messages\" %}\nIf you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met.\n{% /admonition %}\n\n", + "namespace": [ + "Conversations" + ], + "displayName": "Redact a conversation part", + "operationId": "redactConversation", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "redact" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "redact_conversation_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + }, + "description": "Redact a conversation part" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "conversation_part_or_message_not_found", + "message": "Conversation part or message not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/redact", + "responseStatusCode": 200, + "name": "Redact a conversation part", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "conversation", + "id": "471", + "created_at": 1719492938, + "updated_at": 1719492940, + "waiting_since": 1719492939, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918311", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267657", + "name": "Ciaran217 Lee", + "email": "admin217@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d614a8a68186f43bafe42", + "external_id": "70" + } + ] + }, + "first_contact_reply": { + "created_at": 1719492939, + "type": "conversation", + "url": null + }, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": true, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "115", + "part_type": "open", + "body": "

This message was deleted

", + "created_at": 1719492939, + "updated_at": 1719492940, + "notified_at": 1719492939, + "assigned_to": null, + "author": { + "id": "667d614a8a68186f43bafe42", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "external_id": null, + "redacted": true + } + ], + "total_count": 1 + } + } + } + }, + { + "path": "/conversations/redact", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/redact", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_conversations.convertConversationToTicket": { + "id": "endpoint_conversations.convertConversationToTicket", + "description": "You can convert a conversation to a ticket.", + "namespace": [ + "Conversations" + ], + "displayName": "Convert a conversation to a ticket", + "operationId": "convertConversationToTicket", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "conversations" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "convert" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the conversation to target" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "convert_conversation_to_ticket_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Bad request", + "name": "Bad Request", + "examples": [ + { + "name": "Bad request", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Ticket type is not a customer ticket type" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/conversations/{id}/convert", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket", + "id": "474", + "ticket_id": "37", + "ticket_attributes": {}, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "79", + "name": "my-ticket-type-1", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id404_that_should_be_at_least_", + "archived": false, + "created_at": 1719492947, + "updated_at": 1719492947, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [] + }, + "category": "Customer" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61518a68186f43bafe45", + "external_id": "70" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719492945, + "updated_at": 1719492947, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "117", + "part_type": "comment", + "body": "

Comment for message

", + "created_at": 1719492945, + "updated_at": 1719492945, + "author": { + "id": "667d61518a68186f43bafe45", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "118", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719492947, + "updated_at": 1719492947, + "author": { + "id": "991267667", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id404_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 2 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Customer", + "is_shared": true, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + } + }, + { + "path": "/conversations/{id}/convert", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket", + "id": "474", + "ticket_id": "37", + "ticket_attributes": {}, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "79", + "name": "my-ticket-type-1", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id404_that_should_be_at_least_", + "archived": false, + "created_at": 1719492947, + "updated_at": 1719492947, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [] + }, + "category": "Customer" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61518a68186f43bafe45", + "external_id": "70" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719492945, + "updated_at": 1719492947, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "117", + "part_type": "comment", + "body": "

Comment for message

", + "created_at": 1719492945, + "updated_at": 1719492945, + "author": { + "id": "667d61518a68186f43bafe45", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "118", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719492947, + "updated_at": 1719492947, + "author": { + "id": "991267667", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id404_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 2 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Customer", + "is_shared": true, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + } + }, + { + "path": "/conversations/{id}/convert", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/conversations/{id}/convert", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_dataAttributes.lisDataAttributes": { + "id": "endpoint_dataAttributes.lisDataAttributes", + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "namespace": [ + "Data Attributes" + ], + "displayName": "List all data attributes", + "operationId": "lisDataAttributes", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data_attributes" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "model", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "enum", + "values": [ + { + "value": "contact" + }, + { + "value": "company" + }, + { + "value": "conversation" + } + ] + } + } + }, + "description": "Specify the data attribute model to return." + }, + { + "key": "include_archived", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Include archived attributes in the list. By default we return only non archived data attributes." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_attribute_list" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/data_attributes", + "responseStatusCode": 200, + "name": "Successful response", + "queryParameters": { + "model": "company", + "include_archived": false + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "data_attribute", + "name": "name", + "full_name": "name", + "label": "Company name", + "description": "The name of a company", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "company_id", + "full_name": "company_id", + "label": "Company ID", + "description": "A number identifying a company", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "last_request_at", + "full_name": "last_request_at", + "label": "Company last seen", + "description": "The last day anyone from a company visited your site or app", + "data_type": "date", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "remote_created_at", + "full_name": "remote_created_at", + "label": "Company created at", + "description": "The day a company was added to Intercom", + "data_type": "date", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "user_count", + "full_name": "user_count", + "label": "People", + "description": "The number of people in a company", + "data_type": "integer", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "session_count", + "full_name": "session_count", + "label": "Company web sessions", + "description": "All visits from anyone in a company to your product's site or app", + "data_type": "integer", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "name", + "full_name": "plan.name", + "label": "Plan", + "description": "A specific plan or level within your product that companies have signed up to", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "monthly_spend", + "full_name": "monthly_spend", + "label": "Monthly Spend", + "description": "The monthly revenue you receive from a company", + "data_type": "float", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "size", + "full_name": "size", + "label": "Company size", + "description": "The number of people employed in this company, expressed as a single number", + "data_type": "integer", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "industry", + "full_name": "industry", + "label": "Company industry", + "description": "The category or domain this company belongs to e.g. 'ecommerce' or 'SaaS'", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "website", + "full_name": "website", + "label": "Company website", + "description": "The web address for the company's primary marketing site", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "id": 34, + "type": "data_attribute", + "name": "The One Ring", + "full_name": "custom_attributes.The One Ring", + "label": "The One Ring", + "description": "One ring to rule them all, one ring to find them, One ring to bring them all and in the darkness bind them.", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": true, + "archived": false, + "admin_id": "991267684", + "created_at": 1719492954, + "updated_at": 1719492954, + "model": "company" + }, + { + "type": "data_attribute", + "name": "id", + "full_name": "id", + "label": "ID", + "description": "The Intercom defined id representing the company", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "created_at", + "full_name": "created_at", + "label": "Created at", + "description": "The time the company was added to Intercom", + "data_type": "date", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "updated_at", + "full_name": "updated_at", + "label": "Updated at", + "description": "The last time the company was updated", + "data_type": "date", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "id", + "full_name": "plan.id", + "label": "Plan ID", + "description": "The Intercom defined id representing the plan", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "app_id", + "full_name": "app_id", + "label": "App ID", + "description": "The Intercom defined id representing the app", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + } + ] + } + } + } + ] + }, + "endpoint_dataAttributes.createDataAttribute": { + "id": "endpoint_dataAttributes.createDataAttribute", + "description": "You can create a data attributes for a `contact` or a `company`.", + "namespace": [ + "Data Attributes" + ], + "displayName": "Create a data attribute", + "operationId": "createDataAttribute", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data_attributes" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_data_attribute_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_attribute" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Too few options for list", + "name": "Bad Request", + "examples": [ + { + "name": "Same name already exists", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "You already have 'The One Ring' in your company data. To save this as new people data, use a different name." + } + ] + } + } + }, + { + "name": "Invalid name", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Your name for this attribute must only contain alphanumeric characters, currency symbols, and hyphens" + } + ] + } + } + }, + { + "name": "Attribute already exists", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "You already have 'The One Ring' in your company data. To save this as new company data, use a different name." + } + ] + } + } + }, + { + "name": "Invalid Data Type", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Data Type isn't an option" + } + ] + } + } + }, + { + "name": "Too few options for list", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "The Data Attribute model field must be either contact or company" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/data_attributes", + "responseStatusCode": 200, + "name": "Successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": 37, + "type": "data_attribute", + "name": "Mithril Shirt", + "full_name": "custom_attributes.Mithril Shirt", + "label": "Mithril Shirt", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": false, + "custom": true, + "archived": false, + "admin_id": "991267686", + "created_at": 1719492955, + "updated_at": 1719492955, + "model": "company" + } + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_dataAttributes.updateDataAttribute": { + "id": "endpoint_dataAttributes.updateDataAttribute", + "description": "\nYou can update a data attribute.\n\n> 🚧 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.\n", + "namespace": [ + "Data Attributes" + ], + "displayName": "Update a data attribute", + "operationId": "updateDataAttribute", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data_attributes" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The data attribute id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_data_attribute_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_attribute" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Too few options in list", + "name": "Bad Request", + "examples": [ + { + "name": "Too few options in list", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Options isn't an array" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Attribute Not Found", + "name": "Not Found", + "examples": [ + { + "name": "Attribute Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "field_not_found", + "message": "We couldn't find that data attribute to update" + } + ] + } + } + } + ] + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Has Dependant Object", + "name": "Unprocessable Entity", + "examples": [ + { + "name": "Has Dependant Object", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "data_invalid", + "message": "The Data Attribute you are trying to archive has a dependant object" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/data_attributes/{id}", + "responseStatusCode": 200, + "name": "Successful", + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": 44, + "type": "data_attribute", + "name": "The One Ring", + "full_name": "custom_attributes.The One Ring", + "label": "The One Ring", + "description": "Just a plain old ring", + "data_type": "string", + "options": [ + "1-10", + "11-20" + ], + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": true, + "archived": false, + "admin_id": "991267693", + "created_at": 1719492958, + "updated_at": 1719492959, + "model": "company" + } + } + }, + { + "path": "/data_attributes/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/data_attributes/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_dataEvents.lisDataEvents": { + "id": "endpoint_dataEvents.lisDataEvents", + "description": "\n> 🚧\n>\n> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days\n\nThe events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads)\n\nThe `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou can optionally define the result page size as well with the `per_page` parameter.\n", + "namespace": [ + "Data Events" + ], + "displayName": "List all data events", + "operationId": "lisDataEvents", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "events" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "filter", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The value must be user" + }, + { + "key": "summary", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "summary flag" + }, + { + "key": "filter", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + { + "key": "filter", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_event_summary" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/events", + "responseStatusCode": 200, + "name": "Successful response", + "queryParameters": { + "filter": { + "user_id": "string" + }, + "type": "string", + "summary": false + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "event.summary", + "events": [], + "pages": { + "next": "http://api.intercom.test/events?next page" + }, + "email": "user26@email.com", + "intercom_user_id": "667d61648a68186f43bafe4b", + "user_id": "test-uuid-replacement" + } + } + } + ] + }, + "endpoint_dataEvents.createDataEvent": { + "id": "endpoint_dataEvents.createDataEvent", + "description": "\nYou will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`.\n\nWhen using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.\n\nWith the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`).\n\n**NB: For the JSON object types, please note that we do not currently support nested JSON structure.**\n\n| Type | Description | Example |\n| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- |\n| String | The value is a JSON String | `\"source\":\"desktop\"` |\n| Number | The value is a JSON Number | `\"load\": 3.67` |\n| Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `\"contact_date\": 1392036272` |\n| Link | The value is a HTTP or HTTPS URI. | `\"article\": \"https://example.org/ab1de.html\"` |\n| Rich Link | The value is a JSON object that contains `url` and `value` keys. | `\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the dude abides\"}` |\n| Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `\"price\": {\"amount\": 34999, \"currency\": \"eur\"}` |\n\n**Lead Events**\n\nWhen submitting events for Leads, you will need to specify the Lead's `id`.\n\n**Metadata behaviour**\n\n- We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.\n- It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.\n- There might be up to 24 hrs delay when you send a new metadata for an existing event.\n\n**Event de-duplication**\n\nThe API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field.\n\nDuplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.\n\n### HTTP API Responses\n\n- Successful responses to submitted events return `202 Accepted` with an empty body.\n- Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code.\n- Events sent about users that cannot be found will return a `404 Not Found`.\n- Event lists containing duplicate events will have those duplicates ignored.\n- Server errors will return a `500` response code and may contain an error message in the body.\n\n", + "namespace": [ + "Data Events" + ], + "displayName": "Submit a data event", + "operationId": "createDataEvent", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "events" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_data_event_request" + } + } + } + ], + "responses": [], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [] + }, + "endpoint_dataEvents.dataEventSummaries": { + "id": "endpoint_dataEvents.dataEventSummaries", + "description": "Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.\n\n", + "namespace": [ + "Data Events" + ], + "displayName": "Create event summaries", + "operationId": "dataEventSummaries", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "events" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "summaries" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_data_event_summaries_request" + } + } + } + ], + "responses": [], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [] + }, + "endpoint_dataExport.createDataExport": { + "id": "endpoint_dataExport.createDataExport", + "description": "To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>🚧 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.\n\n>📘 Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.\n", + "namespace": [ + "Data Export" + ], + "displayName": "Create content data export", + "operationId": "createDataExport", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "export" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "content" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_data_exports_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_export" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/export/content/data", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "job_identifier": "bxe9awlish03jkq8", + "status": "pending", + "download_url": "", + "download_expires_at": "" + } + } + }, + { + "path": "/export/content/data", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "job_identifier": "bxe9awlish03jkq8", + "status": "pending", + "download_url": "", + "download_expires_at": "" + } + } + }, + { + "path": "/export/content/data", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_dataExport.getDataExport": { + "id": "endpoint_dataExport.getDataExport", + "description": "You can view the status of your job by sending a `GET` request to the URL\n`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model.\n\n> 🚧 Jobs expire after two days\n> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.\n", + "namespace": [ + "Data Export" + ], + "displayName": "Show content data export", + "operationId": "getDataExport", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "export" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "content" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "job_identifier" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "job_identifier", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "job_identifier" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_export" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/export/content/data/{job_identifier}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "job_identifier": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "job_identifier": "b1ppo8h93fj386fk", + "status": "pending", + "download_url": "", + "download_expires_at": "" + } + } + } + ] + }, + "endpoint_dataExport.cancelDataExport": { + "id": "endpoint_dataExport.cancelDataExport", + "description": "You can cancel your job", + "namespace": [ + "Data Export" + ], + "displayName": "Cancel content data export", + "operationId": "cancelDataExport", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "export" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "cancel" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "job_identifier" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "job_identifier", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "job_identifier" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "data_export" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/export/cancel/{job_identifier}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "job_identifier": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "job_identifier": "pwrbmmimhakvlfsh", + "status": "canceled", + "download_url": "", + "download_expires_at": "" + } + } + } + ] + }, + "endpoint_dataExport.downloadDataExport": { + "id": "endpoint_dataExport.downloadDataExport", + "description": "When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message data will be streamed continuously back down to you in a gzipped CSV format.\n\n> 📘 Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n", + "namespace": [ + "Data Export" + ], + "displayName": "Download content data export", + "operationId": "downloadDataExport", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "download" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "content" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "job_identifier" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "job_identifier", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "job_identifier" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [], + "errors": [], + "examples": [] + }, + "endpoint_messages.createMessage": { + "id": "endpoint_messages.createMessage", + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\n\n> 🚧 Sending for visitors\n>\n> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.\n\nThis will return the Message model that has been created.\n\n> 🚧 Retrieving Associated Conversations\n>\n> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.\n", + "namespace": [ + "Messages" + ], + "displayName": "Create a message", + "operationId": "createMessage", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "messages" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_message_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "message" + } + }, + "description": "admin message created" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "No body supplied for email message", + "name": "Bad Request", + "examples": [ + { + "name": "No body supplied for message", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Body is required" + } + ] + } + } + }, + { + "name": "No body supplied for email message", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "Body is required" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 403, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "API plan restricted", + "name": "Forbidden", + "examples": [ + { + "name": "API plan restricted", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed." + } + ] + } + } + } + ] + }, + { + "statusCode": 422, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "No subject supplied for email message", + "name": "Unprocessable Entity", + "examples": [ + { + "name": "No subject supplied for email message", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_not_found", + "message": "No subject supplied for email message" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/messages", + "responseStatusCode": 200, + "name": "user message created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "user_message", + "id": "403918316", + "created_at": 1719492969, + "body": "heyy", + "message_type": "inapp", + "conversation_id": "476" + } + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "name": "lead message created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "user_message", + "id": "403918317", + "created_at": 1719492971, + "body": "heyy", + "message_type": "inapp", + "conversation_id": "477" + } + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "name": "admin message created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "admin_message", + "id": "15", + "created_at": 1719492972, + "subject": "heyy", + "body": "heyy", + "message_type": "inapp", + "owner": { + "type": "admin", + "id": "991267716", + "name": "Ciaran269 Lee", + "email": "admin269@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + } + } + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/messages", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_news.listNewsItems": { + "id": "endpoint_news.listNewsItems", + "description": "You can fetch a list of all news items", + "namespace": [ + "News" + ], + "displayName": "List all news items", + "operationId": "listNewsItems", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news_items" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "paginated_response" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/news_items", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "pages": { + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages" + }, + "data": [ + { + "id": "29", + "type": "news-item", + "workspace_id": "this_is_an_id494_that_should_be_at_least_", + "title": "We have news", + "body": "

Hello there,

", + "sender_id": 991267725, + "state": "draft", + "labels": [], + "cover_image_url": null, + "reactions": [ + null, + null, + null, + null + ], + "deliver_silently": false, + "created_at": 1719492976, + "updated_at": 1719492976, + "newsfeed_assignments": [] + }, + { + "id": "30", + "type": "news-item", + "workspace_id": "this_is_an_id494_that_should_be_at_least_", + "title": "We have news", + "body": "

Hello there,

", + "sender_id": 991267727, + "state": "draft", + "labels": [], + "cover_image_url": null, + "reactions": [ + null, + null, + null, + null + ], + "deliver_silently": false, + "created_at": 1719492976, + "updated_at": 1719492976, + "newsfeed_assignments": [] + } + ], + "total_count": 2 + } + } + } + ] + }, + "endpoint_news.createNewsItem": { + "id": "endpoint_news.createNewsItem", + "description": "You can create a news item", + "namespace": [ + "News" + ], + "displayName": "Create a news item", + "operationId": "createNewsItem", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news_items" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "news_item_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "news_item" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/news_items", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "33", + "type": "news-item", + "workspace_id": "this_is_an_id498_that_should_be_at_least_", + "title": "Halloween is here!", + "body": "

New costumes in store for this spooky season

", + "sender_id": 991267734, + "state": "live", + "labels": [ + "New", + "Product", + "Update" + ], + "cover_image_url": null, + "reactions": [ + "😆", + "😅" + ], + "deliver_silently": true, + "created_at": 1719492978, + "updated_at": 1719492978, + "newsfeed_assignments": [ + { + "newsfeed_id": 53, + "published_at": 1664638214 + } + ] + } + } + }, + { + "path": "/news/news_items", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "33", + "type": "news-item", + "workspace_id": "this_is_an_id498_that_should_be_at_least_", + "title": "Halloween is here!", + "body": "

New costumes in store for this spooky season

", + "sender_id": 991267734, + "state": "live", + "labels": [ + "New", + "Product", + "Update" + ], + "cover_image_url": null, + "reactions": [ + "😆", + "😅" + ], + "deliver_silently": true, + "created_at": 1719492978, + "updated_at": 1719492978, + "newsfeed_assignments": [ + { + "newsfeed_id": 53, + "published_at": 1664638214 + } + ] + } + } + }, + { + "path": "/news/news_items", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_news.retrieveNewsItem": { + "id": "endpoint_news.retrieveNewsItem", + "description": "You can fetch the details of a single news item.", + "namespace": [ + "News" + ], + "displayName": "Retrieve a news item", + "operationId": "retrieveNewsItem", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news_items" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the news item which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "news_item" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "News Item Not Found", + "name": "Not Found", + "examples": [ + { + "name": "News Item Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "34", + "type": "news-item", + "workspace_id": "this_is_an_id502_that_should_be_at_least_", + "title": "We have news", + "body": "

Hello there,

", + "sender_id": 991267737, + "state": "live", + "labels": [], + "cover_image_url": null, + "reactions": [ + null, + null, + null, + null + ], + "deliver_silently": false, + "created_at": 1719492979, + "updated_at": 1719492979, + "newsfeed_assignments": [ + { + "newsfeed_id": 55, + "published_at": 1719492980 + } + ] + } + } + } + ] + }, + "endpoint_news.updateNewsItem": { + "id": "endpoint_news.updateNewsItem", + "namespace": [ + "News" + ], + "displayName": "Update a news item", + "operationId": "updateNewsItem", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news_items" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the news item which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "news_item_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "news_item" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "News Item Not Found", + "name": "Not Found", + "examples": [ + { + "name": "News Item Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "37", + "type": "news-item", + "workspace_id": "this_is_an_id508_that_should_be_at_least_", + "title": "Christmas is here!", + "body": "

New gifts in store for the jolly season

", + "sender_id": 991267745, + "state": "live", + "labels": [], + "cover_image_url": null, + "reactions": [ + "😝", + "😂" + ], + "deliver_silently": false, + "created_at": 1719492982, + "updated_at": 1719492982, + "newsfeed_assignments": [] + } + } + }, + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "37", + "type": "news-item", + "workspace_id": "this_is_an_id508_that_should_be_at_least_", + "title": "Christmas is here!", + "body": "

New gifts in store for the jolly season

", + "sender_id": 991267745, + "state": "live", + "labels": [], + "cover_image_url": null, + "reactions": [ + "😝", + "😂" + ], + "deliver_silently": false, + "created_at": 1719492982, + "updated_at": 1719492982, + "newsfeed_assignments": [] + } + } + }, + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_news.deleteNewsItem": { + "id": "endpoint_news.deleteNewsItem", + "description": "You can delete a single news item.", + "namespace": [ + "News" + ], + "displayName": "Delete a news item", + "operationId": "deleteNewsItem", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news_items" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the news item which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "deleted_object" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "News Item Not Found", + "name": "Not Found", + "examples": [ + { + "name": "News Item Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/news_items/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": 123 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "40", + "object": "news-item", + "deleted": true + } + } + } + ] + }, + "endpoint_news.listLiveNewsfeedItems": { + "id": "endpoint_news.listLiveNewsfeedItems", + "description": "You can fetch a list of all news items that are live on a given newsfeed", + "namespace": [ + "News" + ], + "displayName": "List all live newsfeed items", + "operationId": "listLiveNewsfeedItems", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "newsfeeds" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "items" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the news feed item which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "paginated_response" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/newsfeeds/{id}/items", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "pages": { + "page": 1, + "per_page": 20, + "total_pages": 0, + "type": "pages" + }, + "data": [], + "total_count": 0 + } + } + } + ] + }, + "endpoint_news.listNewsfeeds": { + "id": "endpoint_news.listNewsfeeds", + "description": "You can fetch a list of all newsfeeds", + "namespace": [ + "News" + ], + "displayName": "List all newsfeeds", + "operationId": "listNewsfeeds", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "newsfeeds" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "paginated_response" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/newsfeeds", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "pages": { + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages" + }, + "data": [ + { + "id": "68", + "type": "newsfeed", + "name": "Visitor Feed", + "created_at": 1719492987, + "updated_at": 1719492987 + }, + { + "id": "69", + "type": "newsfeed", + "name": "Visitor Feed", + "created_at": 1719492987, + "updated_at": 1719492987 + } + ], + "total_count": 2 + } + } + } + ] + }, + "endpoint_news.retrieveNewsfeed": { + "id": "endpoint_news.retrieveNewsfeed", + "description": "You can fetch the details of a single newsfeed", + "namespace": [ + "News" + ], + "displayName": "Retrieve a newsfeed", + "operationId": "retrieveNewsfeed", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "news" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "newsfeeds" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the news feed item which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "newsfeed" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/news/newsfeeds/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "id": "72", + "type": "newsfeed", + "name": "Visitor Feed", + "created_at": 1719492988, + "updated_at": 1719492988 + } + } + } + ] + }, + "endpoint_notes.retrieveNote": { + "id": "endpoint_notes.retrieveNote", + "description": "You can fetch the details of a single note.", + "namespace": [ + "Notes" + ], + "displayName": "Retrieve a note", + "operationId": "retrieveNote", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "notes" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier of a given note" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "note" + } + }, + "description": "Note found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Note not found", + "name": "Not Found", + "examples": [ + { + "name": "Note not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/notes/{id}", + "responseStatusCode": 200, + "name": "Note found", + "pathParameters": { + "id": 1 + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "note", + "id": "37", + "created_at": 1718801789, + "contact": { + "type": "contact", + "id": "667d617d8a68186f43bafe58" + }, + "author": { + "type": "admin", + "id": "991267764", + "name": "Ciaran316 Lee", + "email": "admin316@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + } + } + } + ] + }, + "endpoint_segments.listSegments": { + "id": "endpoint_segments.listSegments", + "description": "You can fetch a list of all segments.", + "namespace": [ + "Segments" + ], + "displayName": "List all segments", + "operationId": "listSegments", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "segments" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "include_count", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "It includes the count of contacts that belong to each segment." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "segment_list" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/segments", + "responseStatusCode": 200, + "name": "Successful response", + "queryParameters": { + "include_count": true + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "segment.list", + "segments": [ + { + "type": "segment", + "id": "667d617f8a68186f43bafe5b", + "name": "John segment", + "created_at": 1719492991, + "updated_at": 1719492991, + "person_type": "user" + }, + { + "type": "segment", + "id": "667d617f8a68186f43bafe5c", + "name": "Jane segment", + "created_at": 1719492991, + "updated_at": 1719492991, + "person_type": "user" + } + ] + } + } + } + ] + }, + "endpoint_segments.retrieveSegment": { + "id": "endpoint_segments.retrieveSegment", + "description": "You can fetch the details of a single segment.", + "namespace": [ + "Segments" + ], + "displayName": "Retrieve a segment", + "operationId": "retrieveSegment", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "segments" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identified of a given segment." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "segment" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Segment not found", + "name": "Not Found", + "examples": [ + { + "name": "Segment not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/segments/{id}", + "responseStatusCode": 200, + "name": "Successful response", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "segment", + "id": "667d61808a68186f43bafe5f", + "name": "John segment", + "created_at": 1719492992, + "updated_at": 1719492992, + "person_type": "user" + } + } + } + ] + }, + "endpoint_subscriptionTypes.listSubscriptionTypes": { + "id": "endpoint_subscriptionTypes.listSubscriptionTypes", + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "namespace": [ + "Subscription Types" + ], + "displayName": "List subscription types", + "operationId": "listSubscriptionTypes", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "subscription_types" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "subscription_type_list" + } + }, + "description": "Successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/subscription_types", + "responseStatusCode": 200, + "name": "Successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "subscription", + "id": "137", + "state": "live", + "consent_type": "opt_out", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "email" + ] + } + ] + } + } + } + ] + }, + "endpoint_switch.createPhoneSwitch": { + "id": "endpoint_switch.createPhoneSwitch", + "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", + "namespace": [ + "Switch" + ], + "displayName": "Create a phone Switch", + "operationId": "createPhoneSwitch", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "phone_call_redirects" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_phone_switch_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "phone_switch" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "url": "http://via.intercom.io/msgr/6eb60123-dadb-4881-80fd-4fc2cf272b12", + "type": "phone_call_redirect" + } + } + }, + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "url": "http://via.intercom.io/msgr/6eb60123-dadb-4881-80fd-4fc2cf272b12", + "type": "phone_call_redirect" + } + } + }, + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/phone_call_redirects", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tags.listTags": { + "id": "endpoint_tags.listTags", + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "namespace": [ + "Tags" + ], + "displayName": "List all tags", + "operationId": "listTags", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tags", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "tag", + "id": "115", + "name": "Manual tag 1" + } + ] + } + } + } + ] + }, + "endpoint_tags.createTag": { + "id": "endpoint_tags.createTag", + "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", + "namespace": [ + "Tags" + ], + "displayName": "Create or update a tag, Tag or untag companies, Tag contacts", + "operationId": "createTag", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "Action successful" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Invalid parameters", + "name": "Bad Request", + "examples": [ + { + "name": "Invalid parameters", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_invalid", + "message": "invalid tag parameters" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "User not found", + "name": "Not Found", + "examples": [ + { + "name": "Company not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found" + } + ] + } + } + }, + { + "name": "User not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "User Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tags", + "responseStatusCode": 200, + "name": "Action successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "118", + "name": "test" + } + } + }, + { + "path": "/tags", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "name": "test" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tags", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "test": "invalid" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tags", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "name": "test", + "companies": [ + { + "company_id": "123" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tags", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "name": "test", + "users": [ + { + "id": "123" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tags.findTag": { + "id": "endpoint_tags.findTag", + "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", + "namespace": [ + "Tags" + ], + "displayName": "Find a specific tag", + "operationId": "findTag", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier of a given tag" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "Tag found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag not found", + "name": "Not Found", + "examples": [ + { + "name": "Tag not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tags/{id}", + "responseStatusCode": 200, + "name": "Tag found", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "126", + "name": "Manual tag" + } + } + } + ] + }, + "endpoint_tags.deleteTag": { + "id": "endpoint_tags.deleteTag", + "description": "You can delete the details of tags that are on the workspace by passing in the id.", + "namespace": [ + "Tags" + ], + "displayName": "Delete tag", + "operationId": "deleteTag", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier of a given tag" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag has dependent objects", + "name": "Bad Request", + "examples": [ + { + "name": "Tag has dependent objects", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "tag_has_dependent_objects", + "message": "Unable to delete Tag with dependent objects. Segments: Seg 1." + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Resource not found", + "name": "Not Found", + "examples": [ + { + "name": "Resource not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [] + }, + "endpoint_teams.listTeams": { + "id": "endpoint_teams.listTeams", + "description": "This will return a list of team objects for the App.", + "namespace": [ + "Teams" + ], + "displayName": "List all teams", + "operationId": "listTeams", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "teams" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "team_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/teams", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "team.list", + "teams": [] + } + } + } + ] + }, + "endpoint_teams.retrieveTeam": { + "id": "endpoint_teams.retrieveTeam", + "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", + "namespace": [ + "Teams" + ], + "displayName": "Retrieve a team", + "operationId": "retrieveTeam", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "teams" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier of a given team." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "team" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Team not found", + "name": "Not Found", + "examples": [ + { + "name": "Team not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "team_not_found", + "message": "Team not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/teams/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "team", + "id": "991267802", + "name": "team 1", + "admin_ids": [] + } + } + } + ] + }, + "endpoint_ticketTypeAttributes.createTicketTypeAttribute": { + "id": "endpoint_ticketTypeAttributes.createTicketTypeAttribute", + "description": "You can create a new attribute for a ticket type.", + "namespace": [ + "Ticket Type Attributes" + ], + "displayName": "Create a new attribute for a ticket type", + "operationId": "createTicketTypeAttribute", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "ticket_type_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "attributes" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "ticket_type_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket type which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_ticket_type_attribute_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type_attribute" + } + }, + "description": "Ticket Type Attribute created" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types/{ticket_type_id}/attributes", + "responseStatusCode": 200, + "name": "Ticket Type Attribute created", + "pathParameters": { + "ticket_type_id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_type_attribute", + "id": "210", + "workspace_id": "this_is_an_id600_that_should_be_at_least_", + "name": "Attribute Title", + "description": "Attribute Description", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 2, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": false, + "ticket_type_id": 81, + "archived": false, + "created_at": 1719493013, + "updated_at": 1719493013 + } + } + }, + { + "path": "/ticket_types/{ticket_type_id}/attributes", + "responseStatusCode": 200, + "pathParameters": { + "ticket_type_id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_ticketTypeAttributes.updateTicketTypeAttribute": { + "id": "endpoint_ticketTypeAttributes.updateTicketTypeAttribute", + "description": "You can update an existing attribute for a ticket type.", + "namespace": [ + "Ticket Type Attributes" + ], + "displayName": "Update an existing attribute for a ticket type", + "operationId": "updateTicketTypeAttribute", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "ticket_type_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "attributes" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "ticket_type_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket type which is given by Intercom." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket type attribute which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_ticket_type_attribute_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type_attribute" + } + }, + "description": "Ticket Type Attribute updated" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types/{ticket_type_id}/attributes/{id}", + "responseStatusCode": 200, + "name": "Ticket Type Attribute updated", + "pathParameters": { + "ticket_type_id": "string", + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_type_attribute", + "id": "215", + "workspace_id": "this_is_an_id604_that_should_be_at_least_", + "name": "name", + "description": "New Attribute Description", + "data_type": "string", + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 83, + "archived": false, + "created_at": 1719493013, + "updated_at": 1719493014 + } + } + }, + { + "path": "/ticket_types/{ticket_type_id}/attributes/{id}", + "responseStatusCode": 200, + "pathParameters": { + "ticket_type_id": "string", + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_ticketTypes.listTicketTypes": { + "id": "endpoint_ticketTypes.listTicketTypes", + "description": "You can get a list of all ticket types for a workspace.", + "namespace": [ + "Ticket Types" + ], + "displayName": "List all ticket types", + "operationId": "listTicketTypes", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type_list" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "list", + "data": [ + { + "type": "ticket_type", + "id": "85", + "name": "Bug Report", + "description": "Bug Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "218", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 85, + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014 + }, + { + "type": "ticket_type_attribute", + "id": "220", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "name": "name", + "description": "description", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 85, + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014 + }, + { + "type": "ticket_type_attribute", + "id": "219", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 85, + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014 + } + ] + }, + "category": "Customer" + } + ] + } + } + } + ] + }, + "endpoint_ticketTypes.createTicketType": { + "id": "endpoint_ticketTypes.createTicketType", + "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "namespace": [ + "Ticket Types" + ], + "displayName": "Create a ticket type", + "operationId": "createTicketType", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_ticket_type_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type" + } + }, + "description": "Ticket type created" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types", + "responseStatusCode": 200, + "name": "Ticket type created", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_type", + "id": "88", + "name": "Customer Issue", + "description": "Customer Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id612_that_should_be_at_least_", + "archived": false, + "created_at": 1719493016, + "updated_at": 1719493016, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "227", + "workspace_id": "this_is_an_id612_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 88, + "archived": false, + "created_at": 1719493016, + "updated_at": 1719493016 + }, + { + "type": "ticket_type_attribute", + "id": "228", + "workspace_id": "this_is_an_id612_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 88, + "archived": false, + "created_at": 1719493016, + "updated_at": 1719493016 + } + ] + }, + "category": "Customer" + } + } + }, + { + "path": "/ticket_types", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_ticketTypes.getTicketType": { + "id": "endpoint_ticketTypes.getTicketType", + "description": "You can fetch the details of a single ticket type.", + "namespace": [ + "Ticket Types" + ], + "displayName": "Retrieve a ticket type", + "operationId": "getTicketType", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket type which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type" + } + }, + "description": "Ticket type found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types/{id}", + "responseStatusCode": 200, + "name": "Ticket type found", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_type", + "id": "90", + "name": "Bug Report", + "description": "Bug Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "232", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 90, + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017 + }, + { + "type": "ticket_type_attribute", + "id": "234", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "name": "name", + "description": "description", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 90, + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017 + }, + { + "type": "ticket_type_attribute", + "id": "233", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 90, + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017 + } + ] + }, + "category": "Customer" + } + } + } + ] + }, + "endpoint_ticketTypes.updateTicketType": { + "id": "endpoint_ticketTypes.updateTicketType", + "description": "\nYou can update a ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "namespace": [ + "Ticket Types" + ], + "displayName": "Update a ticket type", + "operationId": "updateTicketType", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "ticket_types" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket type which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_ticket_type_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type" + } + }, + "description": "Ticket type updated" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/ticket_types/{id}", + "responseStatusCode": 200, + "name": "Ticket type updated", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_type", + "id": "92", + "name": "Bug Report 2", + "description": "Bug Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "238", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 92, + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018 + }, + { + "type": "ticket_type_attribute", + "id": "240", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "name": "name", + "description": "description", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 92, + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018 + }, + { + "type": "ticket_type_attribute", + "id": "239", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 92, + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018 + } + ] + }, + "category": "Customer" + } + } + }, + { + "path": "/ticket_types/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tickets.replyTicket": { + "id": "endpoint_tickets.replyTicket", + "description": "You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.", + "namespace": [ + "Tickets" + ], + "displayName": "Reply to a ticket", + "operationId": "replyTicket", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "reply" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_reply" + } + }, + "description": "Admin quick_reply reply" + } + ], + "errors": [ + { + "statusCode": 400, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "User reply", + "name": "Bad Request", + "examples": [ + { + "name": "User reply", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "parameter_mismatch", + "message": "User replies are not allowed on Backoffice tickets" + } + ] + } + } + } + ] + }, + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Not found", + "name": "Not Found", + "examples": [ + { + "name": "Not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "name": "Admin note reply", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_part", + "id": "122", + "part_type": "note", + "body": "

An Unordered HTML List

\n
    \n
  • Coffee
    • \n
  • Tea
    • \n
  • Milk
    • \n
\n

An Ordered HTML List

\n
    \n
  1. Coffee
    2. \n
  2. Tea
    3. \n
  3. Milk
    4. \n
", + "created_at": 1719493024, + "updated_at": 1719493024, + "author": { + "id": "991267829", + "type": "admin", + "name": "Ciaran375 Lee", + "email": "admin375@email.com" + }, + "attachments": [], + "redacted": false + } + } + }, + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "name": "Admin quick_reply reply", + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket_part", + "id": "124", + "part_type": "quick_reply", + "created_at": 1719493029, + "updated_at": 1719493029, + "author": { + "id": "991267834", + "type": "admin", + "name": "Ciaran379 Lee", + "email": "admin379@email.com" + }, + "attachments": [], + "redacted": false + } + } + }, + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "comment", + "type": "user", + "intercom_user_id": "667d619d8a68186f43bafe82", + "body": "Thanks again :)" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "note", + "type": "admin", + "admin_id": 991267829, + "body": "

An Unordered HTML List

  • Coffee
  • Tea
  • Milk

An Ordered HTML List

  1. Coffee
  2. Tea
  3. Milk
" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "quick_reply", + "type": "admin", + "admin_id": 991267834, + "reply_options": [ + { + "text": "Yes", + "uuid": "test-uuid-replacement" + }, + { + "text": "No", + "uuid": "test-uuid-replacement" + } + ] + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{id}/reply", + "responseStatusCode": 200, + "pathParameters": { + "id": "123" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "message_type": "comment", + "type": "user", + "intercom_user_id": "667d61a68a68186f43bafe85", + "body": "Thanks again :)" + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tagsTickets.attachTagToTicket": { + "id": "endpoint_tagsTickets.attachTagToTicket", + "description": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", + "namespace": [ + "Tags", + "Tickets" + ], + "displayName": "Add tag to a ticket", + "operationId": "attachTagToTicket", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "ticket_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "ticket_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ticket_id" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the tag which is given by Intercom" + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the admin which is given by Intercom." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Ticket not found", + "name": "Not Found", + "examples": [ + { + "name": "Ticket not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "ticket_not_found", + "message": "Ticket not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets/{ticket_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "ticket_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "134", + "name": "Manual tag" + } + } + }, + { + "path": "/tickets/{ticket_id}/tags", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "ticket_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 134, + "admin_id": 991267844 + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "134", + "name": "Manual tag" + } + } + }, + { + "path": "/tickets/{ticket_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "ticket_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 134, + "admin_id": 991267844 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{ticket_id}/tags", + "responseStatusCode": 200, + "pathParameters": { + "ticket_id": "64619700005694" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "id": 135, + "admin_id": 991267847 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tagsTickets.detachTagFromTicket": { + "id": "endpoint_tagsTickets.detachTagFromTicket", + "description": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", + "namespace": [ + "Tags", + "Tickets" + ], + "displayName": "Remove tag from a ticket", + "operationId": "detachTagFromTicket", + "method": "DELETE", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "ticket_id" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tags" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "ticket_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ticket_id" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the tag which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the admin which is given by Intercom." + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Tag not found", + "name": "Not Found", + "examples": [ + { + "name": "Ticket not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "ticket_not_found", + "message": "Ticket not found" + } + ] + } + } + }, + { + "name": "Tag not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "tag_not_found", + "message": "Tag not found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets/{ticket_id}/tags/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "ticket_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "137", + "name": "Manual tag" + } + } + }, + { + "path": "/tickets/{ticket_id}/tags/{id}", + "responseStatusCode": 200, + "name": "successful", + "pathParameters": { + "ticket_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267853 + } + }, + "responseBody": { + "type": "json", + "value": { + "type": "tag", + "id": "137", + "name": "Manual tag" + } + } + }, + { + "path": "/tickets/{ticket_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "ticket_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267853 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{ticket_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "ticket_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267856 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{ticket_id}/tags/{id}", + "responseStatusCode": 200, + "pathParameters": { + "ticket_id": "64619700005694", + "id": "7522907" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "requestBody": { + "type": "json", + "value": { + "admin_id": 991267859 + } + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tickets.createTicket": { + "id": "endpoint_tickets.createTicket", + "description": "You can create a new ticket.", + "namespace": [ + "Tickets" + ], + "displayName": "Create a ticket", + "operationId": "createTicket", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "create_ticket_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets", + "responseStatusCode": 200, + "name": "Successful response", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket", + "id": "489", + "ticket_id": "48", + "ticket_attributes": { + "_default_title_": "example", + "_default_description_": "there is a problem" + }, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "106", + "name": "my-ticket-type-15", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id648_that_should_be_at_least_", + "archived": false, + "created_at": 1719493047, + "updated_at": 1719493047, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "252", + "workspace_id": "this_is_an_id648_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 106, + "archived": false, + "created_at": 1719493047, + "updated_at": 1719493047 + }, + { + "type": "ticket_type_attribute", + "id": "253", + "workspace_id": "this_is_an_id648_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 106, + "archived": false, + "created_at": 1719493047, + "updated_at": 1719493047 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61b78a68186f43bafe8d", + "external_id": "70" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719493048, + "updated_at": 1719493048, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "125", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493048, + "updated_at": 1719493048, + "author": { + "id": "991267871", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id648_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 1 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + } + }, + { + "path": "/tickets", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tickets.getTicket": { + "id": "endpoint_tickets.getTicket", + "description": "You can fetch the details of a single ticket.", + "namespace": [ + "Tickets" + ], + "displayName": "Retrieve a ticket", + "operationId": "getTicket", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket which is given by Intercom." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket" + } + }, + "description": "Ticket found" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets/{id}", + "responseStatusCode": 200, + "name": "Ticket found", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket", + "id": "493", + "ticket_id": "52", + "ticket_attributes": { + "_default_title_": "attribute_value", + "_default_description_": null + }, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "112", + "name": "my-ticket-type-21", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id660_that_should_be_at_least_", + "archived": false, + "created_at": 1719493060, + "updated_at": 1719493060, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "268", + "workspace_id": "this_is_an_id660_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 112, + "archived": false, + "created_at": 1719493060, + "updated_at": 1719493060 + }, + { + "type": "ticket_type_attribute", + "id": "269", + "workspace_id": "this_is_an_id660_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 112, + "archived": false, + "created_at": 1719493060, + "updated_at": 1719493060 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61c48a68186f43bafe91", + "external_id": "test-uuid-replacement" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719493061, + "updated_at": 1719493061, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "134", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493061, + "updated_at": 1719493061, + "author": { + "id": "991267912", + "type": "admin", + "name": "Ciaran445 Lee", + "email": "admin445@email.com" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 1 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + } + } + ] + }, + "endpoint_tickets.updateTicket": { + "id": "endpoint_tickets.updateTicket", + "description": "You can update a ticket.", + "namespace": [ + "Tickets" + ], + "displayName": "Update a ticket", + "operationId": "updateTicket", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "id" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "pathParameters": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket which is given by Intercom" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_ticket_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket" + } + }, + "description": "Successful response" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/tickets/{id}", + "responseStatusCode": 200, + "name": "Successful response", + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket", + "id": "490", + "ticket_id": "49", + "ticket_attributes": { + "_default_title_": "example", + "_default_description_": "there is a problem" + }, + "ticket_state": "in_progress", + "ticket_type": { + "type": "ticket_type", + "id": "108", + "name": "my-ticket-type-17", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + "archived": false, + "created_at": 1719493050, + "updated_at": 1719493050, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "257", + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 108, + "archived": false, + "created_at": 1719493050, + "updated_at": 1719493050 + }, + { + "type": "ticket_type_attribute", + "id": "258", + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 108, + "archived": false, + "created_at": 1719493050, + "updated_at": 1719493050 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61bb8a68186f43bafe8e", + "external_id": "test-uuid-replacement" + } + ] + }, + "admin_assignee_id": "991267885", + "team_assignee_id": "0", + "created_at": 1719493051, + "updated_at": 1719493054, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "126", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493051, + "updated_at": 1719493051, + "author": { + "id": "991267883", + "type": "admin", + "name": "Ciaran419 Lee", + "email": "admin419@email.com" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "127", + "part_type": "ticket_attribute_updated_by_admin", + "created_at": 1719493053, + "updated_at": 1719493053, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "128", + "part_type": "ticket_attribute_updated_by_admin", + "created_at": 1719493053, + "updated_at": 1719493053, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "129", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "in_progress", + "previous_ticket_state": "submitted", + "created_at": 1719493053, + "updated_at": 1719493053, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "130", + "part_type": "assignment", + "created_at": 1719493054, + "updated_at": 1719493054, + "assigned_to": { + "type": "admin", + "id": "991267885" + }, + "author": { + "id": "991267883", + "type": "admin", + "name": "Ciaran419 Lee", + "email": "admin419@email.com" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "131", + "part_type": "snoozed", + "created_at": 1719493054, + "updated_at": 1719493054, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 6 + }, + "open": true, + "snoozed_until": 1719590400, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "In progress", + "ticket_state_external_label": "In progress" + } + } + }, + { + "path": "/tickets/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/tickets/{id}", + "responseStatusCode": 200, + "pathParameters": { + "id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_tickets.searchTickets": { + "id": "endpoint_tickets.searchTickets", + "description": "You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`.\n\nThis will accept a query object in the body which will define your filters.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiples there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foobar\"`).\n\n| Field | Type |\n| :---------------------------------------- | :--------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| _default_title_ | String |\n| _default_description_ | String |\n| category | String |\n| ticket_type_id | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | String |\n| team_assignee_id | String |\n| open | Boolean |\n| state | String |\n| snoozed_until | Date (UNIX timestamp) |\n| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |\n\n### Accepted Operators\n\n{% admonition type=\"info\" name=\"Searching based on `created_at`\" %}\n You may use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "namespace": [ + "Tickets" + ], + "displayName": "Search tickets", + "operationId": "searchTickets", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "tickets" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "search" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "search_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_list" + } + }, + "description": "successful" + } + ], + "errors": [], + "examples": [ + { + "path": "/tickets/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 1 + }, + "total_count": 1, + "tickets": [ + { + "type": "ticket", + "id": "494", + "ticket_id": "53", + "ticket_attributes": { + "_default_title_": "attribute_value", + "_default_description_": null + }, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "117", + "name": "my-ticket-type-26", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "279", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 117, + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065 + }, + { + "type": "ticket_type_attribute", + "id": "280", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 117, + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61c98a68186f43bafe92", + "external_id": "test-uuid-replacement" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719493065, + "updated_at": 1719493066, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "135", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493066, + "updated_at": 1719493066, + "author": { + "id": "991267940", + "type": "admin", + "name": "Ciaran472 Lee", + "email": "admin472@email.com" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 1 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + ] + } + } + }, + { + "path": "/tickets/search", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "ticket.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 1 + }, + "total_count": 1, + "tickets": [ + { + "type": "ticket", + "id": "494", + "ticket_id": "53", + "ticket_attributes": { + "_default_title_": "attribute_value", + "_default_description_": null + }, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "117", + "name": "my-ticket-type-26", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "279", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 117, + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065 + }, + { + "type": "ticket_type_attribute", + "id": "280", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 117, + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61c98a68186f43bafe92", + "external_id": "test-uuid-replacement" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719493065, + "updated_at": 1719493066, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "135", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493066, + "updated_at": 1719493066, + "author": { + "id": "991267940", + "type": "admin", + "name": "Ciaran472 Lee", + "email": "admin472@email.com" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 1 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + ] + } + } + }, + { + "path": "/tickets/search", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_visitors.retrieveVisitorWithUserId": { + "id": "endpoint_visitors.retrieveVisitorWithUserId", + "description": "You can fetch the details of a single visitor.", + "namespace": [ + "Visitors" + ], + "displayName": "Retrieve a visitor with User ID", + "operationId": "retrieveVisitorWithUserId", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "visitors" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "queryParameters": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The user_id of the Visitor you want to retrieve." + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "visitor" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Visitor not found", + "name": "Not Found", + "examples": [ + { + "name": "Visitor not found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Visitor Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/visitors", + "responseStatusCode": 200, + "name": "successful", + "queryParameters": { + "user_id": "string" + }, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "visitor", + "id": "667d61ce8a68186f43bafe9b", + "user_id": "test-uuid-replacement", + "anonymous": true, + "email": "", + "phone": null, + "name": null, + "pseudonym": null, + "avatar": { + "type": "avatar", + "image_url": null + }, + "app_id": "this_is_an_id677_that_should_be_at_least_", + "companies": { + "type": "company.list", + "companies": [] + }, + "location_data": {}, + "last_request_at": null, + "created_at": 1719493070, + "remote_created_at": 1719493070, + "signed_up_at": 1719493070, + "updated_at": 1719493070, + "session_count": 0, + "social_profiles": { + "type": "social_profile.list", + "social_profiles": [] + }, + "owner_id": null, + "unsubscribed_from_emails": false, + "marked_email_as_spam": false, + "has_hard_bounced": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "custom_attributes": {}, + "referrer": null, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "do_not_track": null + } + } + } + ] + }, + "endpoint_visitors.updateVisitor": { + "id": "endpoint_visitors.updateVisitor", + "description": "Sending a PUT request to `/visitors` will result in an update of an existing Visitor.\n\n**Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body.\n\n**Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body.\n", + "namespace": [ + "Visitors" + ], + "displayName": "Update a visitor", + "operationId": "updateVisitor", + "method": "PUT", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "visitors" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "update_visitor_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "visitor" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + }, + { + "statusCode": 404, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "visitor Not Found", + "name": "Not Found", + "examples": [ + { + "name": "visitor Not Found", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "not_found", + "message": "Visitor Not Found" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/visitors", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "visitor", + "id": "667d61cc8a68186f43bafe95", + "user_id": "test-uuid-replacement", + "anonymous": true, + "email": "", + "phone": null, + "name": "Gareth Bale", + "pseudonym": "Indigo Ghost", + "avatar": { + "type": "avatar", + "image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png" + }, + "app_id": "this_is_an_id671_that_should_be_at_least_", + "companies": { + "type": "company.list", + "companies": [] + }, + "location_data": {}, + "last_request_at": null, + "created_at": 1719493068, + "remote_created_at": 1719493068, + "signed_up_at": 1719493068, + "updated_at": 1719493068, + "session_count": 0, + "social_profiles": { + "type": "social_profile.list", + "social_profiles": [] + }, + "owner_id": null, + "unsubscribed_from_emails": false, + "marked_email_as_spam": false, + "has_hard_bounced": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "custom_attributes": {}, + "referrer": null, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "do_not_track": null + } + } + }, + { + "path": "/visitors", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "visitor", + "id": "667d61cc8a68186f43bafe95", + "user_id": "test-uuid-replacement", + "anonymous": true, + "email": "", + "phone": null, + "name": "Gareth Bale", + "pseudonym": "Indigo Ghost", + "avatar": { + "type": "avatar", + "image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png" + }, + "app_id": "this_is_an_id671_that_should_be_at_least_", + "companies": { + "type": "company.list", + "companies": [] + }, + "location_data": {}, + "last_request_at": null, + "created_at": 1719493068, + "remote_created_at": 1719493068, + "signed_up_at": 1719493068, + "updated_at": 1719493068, + "session_count": 0, + "social_profiles": { + "type": "social_profile.list", + "social_profiles": [] + }, + "owner_id": null, + "unsubscribed_from_emails": false, + "marked_email_as_spam": false, + "has_hard_bounced": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "custom_attributes": {}, + "referrer": null, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "do_not_track": null + } + } + }, + { + "path": "/visitors", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + }, + { + "path": "/visitors", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + }, + "endpoint_visitors.convertVisitor": { + "id": "endpoint_visitors.convertVisitor", + "description": "You can merge a Visitor to a Contact of role type `lead` or `user`.\n\n> 📘 What happens upon a visitor being converted?\n>\n> If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers.\n", + "namespace": [ + "Visitors" + ], + "displayName": "Convert a visitor", + "operationId": "convertVisitor", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "visitors" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "convert" + } + ], + "auth": [ + "bearerAuth" + ], + "defaultEnvironment": "https://api.intercom.io", + "environments": [ + { + "id": "https://api.intercom.io", + "baseUrl": "https://api.intercom.io" + }, + { + "id": "https://api.eu.intercom.io", + "baseUrl": "https://api.eu.intercom.io" + }, + { + "id": "https://api.au.intercom.io", + "baseUrl": "https://api.au.intercom.io" + } + ], + "requestHeaders": [ + { + "key": "Intercom-Version", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "intercom_version", + "default": "2.11" + } + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "convert_visitor_request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + }, + "description": "successful" + } + ], + "errors": [ + { + "statusCode": 401, + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "error" + } + }, + "description": "Unauthorized", + "name": "Unauthorized", + "examples": [ + { + "name": "Unauthorized", + "responseBody": { + "type": "json", + "value": { + "type": "error.list", + "request_id": "test-uuid-replacement", + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid" + } + ] + } + } + } + ] + } + ], + "examples": [ + { + "path": "/visitors/convert", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d61d08a68186f43bafea2", + "workspace_id": "this_is_an_id683_that_should_be_at_least_", + "external_id": null, + "role": "user", + "email": "foo@bar.com", + "phone": null, + "name": null, + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719493072, + "updated_at": 1719493072, + "signed_up_at": 1719493072, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/visitors/convert", + "responseStatusCode": 200, + "name": "successful", + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": { + "type": "contact", + "id": "667d61d08a68186f43bafea2", + "workspace_id": "this_is_an_id683_that_should_be_at_least_", + "external_id": null, + "role": "user", + "email": "foo@bar.com", + "phone": null, + "name": null, + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719493072, + "updated_at": 1719493072, + "signed_up_at": 1719493072, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + }, + { + "path": "/visitors/convert", + "responseStatusCode": 200, + "headers": { + "Intercom-Version": "2.11" + }, + "responseBody": { + "type": "json", + "value": {} + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "activity_log": { + "name": "Activity Log", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the activity." + }, + { + "key": "performed_by", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `admin`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the admin." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email of the admin." + }, + { + "key": "ip", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The IP address of the admin." + } + ] + }, + "description": "Details about the Admin involved in the activity." + }, + { + "key": "metadata", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "activity_log_metadata" + } + } + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the activity was created." + }, + { + "key": "activity_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin_assignment_limit_change" + }, + { + "value": "admin_away_mode_change" + }, + { + "value": "admin_deletion" + }, + { + "value": "admin_deprovisioned" + }, + { + "value": "admin_impersonation_end" + }, + { + "value": "admin_impersonation_start" + }, + { + "value": "admin_invite_change" + }, + { + "value": "admin_invite_creation" + }, + { + "value": "admin_invite_deletion" + }, + { + "value": "admin_login_failure" + }, + { + "value": "admin_login_success" + }, + { + "value": "admin_logout" + }, + { + "value": "admin_password_reset_request" + }, + { + "value": "admin_password_reset_success" + }, + { + "value": "admin_permission_change" + }, + { + "value": "admin_provisioned" + }, + { + "value": "admin_two_factor_auth_change" + }, + { + "value": "admin_unauthorized_sign_in_method" + }, + { + "value": "app_admin_join" + }, + { + "value": "app_authentication_method_change" + }, + { + "value": "app_data_deletion" + }, + { + "value": "app_data_export" + }, + { + "value": "app_google_sso_domain_change" + }, + { + "value": "app_identity_verification_change" + }, + { + "value": "app_name_change" + }, + { + "value": "app_outbound_address_change" + }, + { + "value": "app_package_installation" + }, + { + "value": "app_package_token_regeneration" + }, + { + "value": "app_package_uninstallation" + }, + { + "value": "app_team_creation" + }, + { + "value": "app_team_deletion" + }, + { + "value": "app_team_membership_modification" + }, + { + "value": "app_timezone_change" + }, + { + "value": "app_webhook_creation" + }, + { + "value": "app_webhook_deletion" + }, + { + "value": "articles_in_messenger_enabled_change" + }, + { + "value": "bulk_delete" + }, + { + "value": "bulk_export" + }, + { + "value": "campaign_deletion" + }, + { + "value": "campaign_state_change" + }, + { + "value": "conversation_part_deletion" + }, + { + "value": "conversation_topic_change" + }, + { + "value": "conversation_topic_creation" + }, + { + "value": "conversation_topic_deletion" + }, + { + "value": "help_center_settings_change" + }, + { + "value": "inbound_conversations_change" + }, + { + "value": "inbox_access_change" + }, + { + "value": "message_deletion" + }, + { + "value": "message_state_change" + }, + { + "value": "messenger_look_and_feel_change" + }, + { + "value": "messenger_search_required_change" + }, + { + "value": "messenger_spaces_change" + }, + { + "value": "office_hours_change" + }, + { + "value": "role_change" + }, + { + "value": "role_creation" + }, + { + "value": "role_deletion" + }, + { + "value": "ruleset_activation_title_preview" + }, + { + "value": "ruleset_creation" + }, + { + "value": "ruleset_deletion" + }, + { + "value": "search_browse_enabled_change" + }, + { + "value": "search_browse_required_change" + }, + { + "value": "seat_change" + }, + { + "value": "seat_revoke" + }, + { + "value": "security_settings_change" + }, + { + "value": "temporary_expectation_change" + }, + { + "value": "upfront_email_collection_change" + }, + { + "value": "welcome_message_change" + } + ] + } + }, + { + "key": "activity_description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A sentence or two describing the activity." + } + ] + } + } + }, + "description": "Activities performed by Admins." + }, + "activity_log_list": { + "name": "Paginated Response", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `activity_log.list`." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "activity_logs", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "activity_log" + } + } + } + }, + "description": "An array of activity logs" + } + ] + }, + "description": "A paginated list of activity logs." + }, + "activity_log_metadata": { + "name": "Activity Log Metadata", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "sign_in_method", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The way the admin signed in." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + }, + { + "key": "away_mode", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "The away mode status which is set to true when away and false when returned." + }, + { + "key": "away_status_reason", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The reason the Admin is away." + }, + { + "key": "reassign_conversations", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Indicates if conversations should be reassigned while an Admin is away." + }, + { + "key": "source", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The action that initiated the status change." + }, + { + "key": "auto_changed", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Indicates if the status was changed automatically or manually." + }, + { + "key": "update_by", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The ID of the Admin who initiated the activity." + }, + { + "key": "update_by_name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the Admin who initiated the activity." + } + ] + } + } + }, + "description": "Additional data provided about Admin activity." + }, + "addressable_list": { + "name": "Addressable List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "The addressable object type" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the addressable object" + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "Url to get more company resources for this contact" + } + ] + }, + "description": "A list used to access other resources from a parent model." + }, + "admin": { + "name": "Admin", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `admin`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the admin." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the admin." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email of the admin." + }, + { + "key": "job_title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The job title of the admin." + }, + { + "key": "away_mode_enabled", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin is currently set in away mode." + }, + { + "key": "away_mode_reassign", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox." + }, + { + "key": "has_inbox_seat", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them." + }, + { + "key": "team_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "This object represents the avatar associated with the admin." + }, + { + "key": "avatar", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "Image for the associated team or teammate" + }, + { + "key": "team_priority_level", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "team_priority_level" + } + } + } + ] + } + } + }, + "description": "Admins are teammate accounts that have access to a workspace." + }, + "admin_list": { + "name": "Admins", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `admin.list`." + }, + { + "key": "admins", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "admin" + } + } + } + }, + "description": "A list of admins associated with a given workspace." + } + ] + }, + "description": "A list of admins associated with a given workspace." + }, + "admin_priority_level": { + "name": "Admin Priority Level", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "primary_admin_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The primary admin ids for the team" + }, + { + "key": "secondary_admin_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The secondary admin ids for the team" + } + ] + } + } + }, + "description": "Admin priority levels for the team" + }, + "admin_reply_conversation_request": { + "name": "Admin Reply", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "comment" + }, + { + "value": "note" + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin" + } + ] + } + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types." + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is authoring the comment." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time the reply was created. If not provided, the current time will be used." + }, + { + "key": "attachment_urls", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + } + } + }, + "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs." + }, + { + "key": "attachment_files", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_attachment_files" + } + } + } + } + } + }, + "description": "A list of files that will be added as attachments. You can include up to 10 files" + } + ] + }, + "description": "Payload of the request to reply on behalf of an admin" + }, + "admin_reply_ticket_request": { + "name": "Admin Reply on ticket", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "comment" + }, + { + "value": "note" + }, + { + "value": "quick_reply" + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin" + } + ] + } + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types." + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is authoring the comment." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time the reply was created. If not provided, the current time will be used." + }, + { + "key": "reply_options", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The text to display in this quick reply option." + }, + { + "key": "uuid", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + }, + "description": "A unique identifier for this quick reply option. This value will be available within the metadata of the comment ticket part that is created when a user clicks on this reply option." + } + ] + } + } + } + } + }, + "description": "The quick reply options to display. Must be present for quick_reply message types." + }, + { + "key": "attachment_urls", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + } + } + }, + "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs." + } + ] + }, + "description": "Payload of the request to reply on behalf of an admin" + }, + "admin_with_app": { + "name": "Admin", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `admin`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the admin." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the admin." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email of the admin." + }, + { + "key": "job_title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The job title of the admin." + }, + { + "key": "away_mode_enabled", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin is currently set in away mode." + }, + { + "key": "away_mode_reassign", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox." + }, + { + "key": "has_inbox_seat", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them." + }, + { + "key": "team_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "This is a list of ids of the teams that this admin is part of." + }, + { + "key": "avatar", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "avatar" + } + } + }, + "description": "This is a string that identifies the type of the object. It will always have the value `avatar`." + }, + { + "key": "image_url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "This object represents the avatar associated with the admin." + } + ] + }, + "description": "This object represents the avatar associated with the admin." + }, + { + "key": "email_verified", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Identifies if this admin's email is verified." + }, + { + "key": "app", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "app" + } + } + } + }, + "description": "App that the admin belongs to." + } + ] + } + } + }, + "description": "Admins are the teammate accounts that have access to a workspace" + }, + "ai_agent": { + "name": "AI Agent", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "source_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "essentials_plan_setup" + }, + { + "value": "profile" + }, + { + "value": "workflow" + }, + { + "value": "workflow_preview" + }, + { + "value": "fin_preview" + } + ] + }, + "description": "The type of the source that triggered AI Agent involvement in the conversation." + }, + { + "key": "source_title", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The title of the source that triggered AI Agent involvement in the conversation. If this is `essentials_plan_setup` then it will return `null`." + }, + { + "key": "last_answer_type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [] + } + } + }, + "description": "The type of the last answer delivered by AI Agent. If no answer was delivered then this will return `null`" + }, + { + "key": "resolution_state", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [ + { + "value": "assumed_resolution" + }, + { + "value": "confirmed_resolution" + }, + { + "value": "routed_to_team" + }, + { + "value": "abandoned" + } + ] + } + } + }, + "description": "The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return `null`." + }, + { + "key": "rating", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The customer satisfaction rating given to AI Agent, from 1-5." + }, + { + "key": "rating_remark", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The customer satisfaction rating remark given to AI Agent." + }, + { + "key": "content_sources", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "content_sources_list" + } + } + } + ] + }, + "description": "Data related to AI Agent involvement in the conversation." + }, + "app": { + "name": "App", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "app" + } + } + }, + "description": "" + }, + { + "key": "id_code", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the app." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the app." + }, + { + "key": "region", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom region the app is located in." + }, + { + "key": "timezone", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The timezone of the region where the app is located." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "When the app was created." + }, + { + "key": "identity_verification", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the app uses identity verification." + } + ] + } + } + }, + "description": "App is a workspace on Intercom" + }, + "article": { + "name": "Article", + "shape": { + "type": "object", + "extends": [ + "article_list_item" + ], + "properties": [ + { + "key": "statistics", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_statistics" + } + } + } + } + } + ] + }, + "description": "The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone." + }, + "article_content": { + "name": "Article Content", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [] + } + } + }, + "description": "The type of object - `article_content` ." + }, + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the article." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the article." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The body of the article." + }, + { + "key": "author_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The ID of the author of the article." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "published" + }, + { + "value": "draft" + } + ] + }, + "description": "Whether the article is `published` or is a `draft` ." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was created (seconds)." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was last updated (seconds)." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL of the article." + } + ] + } + } + }, + "description": "The Content of an Article." + }, + "article_list": { + "name": "Articles", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object - `list`." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of articles." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_list_item" + } + } + } + }, + "description": "An array of Article objects" + } + ] + }, + "description": "This will return a list of articles for the App." + }, + "article_list_item": { + "name": "Articles", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "article" + } + ], + "default": "article" + }, + "description": "The type of object - `article`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the article which is given by Intercom." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace which the article belongs to." + }, + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the article. For multilingual articles, this will be the title of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The description of the article. For multilingual articles, this will be the description of the default language's content." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The body of the article in HTML. For multilingual articles, this will be the body of the default language's content." + }, + { + "key": "author_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "published" + }, + { + "value": "draft" + } + ], + "default": "draft" + }, + "description": "Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The URL of the article. For multilingual articles, this will be the URL of the default language's content." + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of the article's parent collection or section. An article without this field stands alone." + }, + { + "key": "parent_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The ids of the article's parent collections or sections. An article without this field stands alone." + }, + { + "key": "parent_type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The type of parent, which can either be a `collection` or `section`." + }, + { + "key": "default_locale", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The default locale of the help center. This field is only returned for multilingual help centers." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_translated_content" + } + } + } + } + } + ] + }, + "description": "The data returned about your articles when you list them." + }, + "article_search_highlights": { + "name": "Article Search Highlights", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "article_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the corresponding article." + }, + { + "key": "highlighted_title", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "highlight" + }, + { + "value": "plain" + } + ] + }, + "description": "The type of text - `highlight` or `plain`." + }, + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The text of the title." + } + ] + } + } + }, + "description": "An Article title highlighted." + }, + { + "key": "highlighted_summary", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "highlight" + }, + { + "value": "plain" + } + ] + }, + "description": "The type of text - `highlight` or `plain`." + }, + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The text of the title." + } + ] + } + } + } + } + }, + "description": "An Article description and body text highlighted." + } + ] + }, + "description": "The highlighted results of an Article search. In the examples provided my search query is always \"my query\"." + }, + "article_search_response": { + "name": "Article Search Response", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object - `list`." + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of Articles matching the search query" + }, + { + "key": "data", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "articles", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article" + } + } + } + }, + "description": "An array of Article objects" + }, + { + "key": "highlights", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_search_highlights" + } + } + } + }, + "description": "A corresponding array of highlighted Article content" + } + ] + }, + "description": "An object containing the results of the search." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "The results of an Article search" + }, + "article_statistics": { + "name": "Article Statistics", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "article_statistics" + } + ], + "default": "article_statistics" + }, + "description": "The type of object - `article_statistics`." + }, + { + "key": "views", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of total views the article has received." + }, + { + "key": "conversions", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of conversations started from the article." + }, + { + "key": "reactions", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of total reactions the article has received." + }, + { + "key": "happy_reaction_percentage", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The percentage of happy reactions the article has received against other types of reaction." + }, + { + "key": "neutral_reaction_percentage", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The percentage of neutral reactions the article has received against other types of reaction." + }, + { + "key": "sad_reaction_percentage", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + }, + "description": "The percentage of sad reactions the article has received against other types of reaction." + } + ] + } + } + }, + "description": "The statistics of an article." + }, + "article_translated_content": { + "name": "Article Translated Content", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [] + } + } + }, + "description": "The type of object - article_translated_content." + }, + { + "key": "ar", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Arabic" + }, + { + "key": "bg", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Bulgarian" + }, + { + "key": "bs", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Bosnian" + }, + { + "key": "ca", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Catalan" + }, + { + "key": "cs", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Czech" + }, + { + "key": "da", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Danish" + }, + { + "key": "de", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in German" + }, + { + "key": "el", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Greek" + }, + { + "key": "en", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in English" + }, + { + "key": "es", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Spanish" + }, + { + "key": "et", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Estonian" + }, + { + "key": "fi", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Finnish" + }, + { + "key": "fr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in French" + }, + { + "key": "he", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Hebrew" + }, + { + "key": "hr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Croatian" + }, + { + "key": "hu", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Hungarian" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Indonesian" + }, + { + "key": "it", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Italian" + }, + { + "key": "ja", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Japanese" + }, + { + "key": "ko", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Korean" + }, + { + "key": "lt", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Lithuanian" + }, + { + "key": "lv", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Latvian" + }, + { + "key": "mn", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Mongolian" + }, + { + "key": "nb", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Norwegian" + }, + { + "key": "nl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Dutch" + }, + { + "key": "pl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Polish" + }, + { + "key": "pt", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Portuguese (Portugal)" + }, + { + "key": "ro", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Romanian" + }, + { + "key": "ru", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Russian" + }, + { + "key": "sl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Slovenian" + }, + { + "key": "sr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Serbian" + }, + { + "key": "sv", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Swedish" + }, + { + "key": "tr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Turkish" + }, + { + "key": "vi", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Vietnamese" + }, + { + "key": "pt-BR", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Portuguese (Brazil)" + }, + { + "key": "zh-CN", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Chinese (China)" + }, + { + "key": "zh-TW", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_content" + } + }, + "description": "The content of the article in Chinese (Taiwan)" + } + ] + } + } + }, + "description": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article." + }, + "assign_conversation_request": { + "name": "Assign Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "assignment" + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin" + }, + { + "value": "team" + } + ] + } + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is performing the action." + }, + { + "key": "assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The `id` of the `admin` or `team` which will be assigned the conversation. A conversation can be assigned both an admin and a team.\\nSet `0` if you want this assign to no admin or team (ie. Unassigned)." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Optionally you can send a response in the conversation when it is assigned." + } + ] + }, + "description": "Payload of the request to assign a conversation" + }, + "attach_contact_to_conversation_request": { + "name": "Assign Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The `id` of the admin who is adding the new participant." + }, + { + "key": "customer", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + }, + { + "key": "customer", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "customer_request" + } + } + } + } + } + ] + } + } + ] + }, + "description": "Payload of the request to assign a conversation" + }, + "close_conversation_request": { + "name": "Close Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "close" + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin" + } + ] + } + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is performing the action." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Optionally you can leave a message in the conversation to provide additional context to the user and other teammates." + } + ] + }, + "description": "Payload of the request to close a conversation" + }, + "collection": { + "name": "Collection", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the collection which is given by Intercom." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace which the collection belongs to." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The description of the collection. For multilingual help centers, this will be the description of the collection for the default language." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language." + }, + { + "key": "icon", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The icon of the collection." + }, + { + "key": "order", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order." + }, + { + "key": "default_locale", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The default locale of the help center. This field is only returned for multilingual help centers." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_translated_content" + } + } + } + } + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The id of the parent collection. If `null` then it is the first level collection." + }, + { + "key": "help_center_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of the help center the collection is in." + } + ] + }, + "description": "Collections are top level containers for Articles within the Help Center." + }, + "collection_list": { + "name": "Collections", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object - `list`." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of collections." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "collection" + } + } + } + }, + "description": "An array of collection objects" + } + ] + }, + "description": "This will return a list of Collections for the App." + }, + "company": { + "name": "Company", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "company" + } + ] + }, + "description": "Value is `company`" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the company." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the company." + }, + { + "key": "app_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined code of the workspace the company is associated to." + }, + { + "key": "plan", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Value is always \"plan\"" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the plan" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the plan" + } + ] + } + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The company id you have defined for the company." + }, + { + "key": "remote_created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the company was created by you." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the company was added in Intercom." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the company was updated." + }, + { + "key": "last_request_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the company last recorded making a request." + }, + { + "key": "size", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of employees in the company." + }, + { + "key": "website", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL for the company website." + }, + { + "key": "industry", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The industry that the company operates in." + }, + { + "key": "monthly_spend", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "How much revenue the company generates for your business." + }, + { + "key": "session_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "How many sessions the company has recorded." + }, + { + "key": "user_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of users in the company." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The custom attributes you have set on the company." + }, + { + "key": "tags", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "tag.list" + } + ] + }, + "description": "The type of the object" + } + ] + }, + "description": "The list of tags associated with the company" + }, + { + "key": "segments", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "segment.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "segments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "segment" + } + } + } + } + } + ] + }, + "description": "The list of segments associated with the company" + } + ] + }, + "description": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies." + }, + "company_attached_contacts": { + "name": "Company Attached Contacts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of object - `list`" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + } + } + }, + "description": "An array containing Contact Objects" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of contacts" + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "A list of Contact Objects" + }, + "company_attached_segments": { + "name": "Company Attached Segments", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of object - `list`" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "segment" + } + } + } + }, + "description": "An array containing Segment Objects" + } + ] + }, + "description": "A list of Segment Objects" + }, + "company_list": { + "name": "Companies", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of object - `list`." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of companies." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + } + } + }, + "description": "An array containing Company Objects." + } + ] + }, + "description": "This will return a list of companies for the App." + }, + "company_scroll": { + "name": "Company Scroll", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of object - `list`" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + } + } + } + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The total number of companies" + }, + { + "key": "scroll_param", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The scroll parameter to use in the next request to fetch the next page of results." + } + ] + } + } + }, + "description": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies." + }, + "contact": { + "name": "Contact", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of object." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace which the contact belongs to." + }, + { + "key": "role", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role of the contact." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The contact's email." + }, + { + "key": "email_domain", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The contact's email domain." + }, + { + "key": "phone", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The contacts phone." + }, + { + "key": "formatted_phone", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The contacts phone number normalized to the E164 format" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The contacts name." + }, + { + "key": "owner_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of an admin that has been assigned account ownership of the contact." + }, + { + "key": "has_hard_bounced", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact has had an email sent to them hard bounce." + }, + { + "key": "marked_email_as_spam", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact has marked an email sent to them as spam." + }, + { + "key": "unsubscribed_from_emails", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact is unsubscribed from emails." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "(UNIX timestamp) The time when the contact was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "(UNIX timestamp) The time when the contact was last updated." + }, + { + "key": "signed_up_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time specified for when a contact signed up." + }, + { + "key": "last_seen_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)." + }, + { + "key": "last_replied_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact last messaged in." + }, + { + "key": "last_contacted_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact was last messaged." + }, + { + "key": "last_email_opened_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact last opened an email." + }, + { + "key": "last_email_clicked_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact last clicked a link in an email." + }, + { + "key": "language_override", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change." + }, + { + "key": "browser", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the browser which the contact is using." + }, + { + "key": "browser_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the browser which the contact is using." + }, + { + "key": "browser_language", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The language set by the browser which the contact is using." + }, + { + "key": "os", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The operating system which the contact is using." + }, + { + "key": "android_app_name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the Android app which the contact is using." + }, + { + "key": "android_app_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the Android app which the contact is using." + }, + { + "key": "android_device", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The Android device which the contact is using." + }, + { + "key": "android_os_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the Android OS which the contact is using." + }, + { + "key": "android_sdk_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the Android SDK which the contact is using." + }, + { + "key": "android_last_seen_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The time when the contact was last seen on an Android device." + }, + { + "key": "ios_app_name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the iOS app which the contact is using." + }, + { + "key": "ios_app_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the iOS app which the contact is using." + }, + { + "key": "ios_device", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The iOS device which the contact is using." + }, + { + "key": "ios_os_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of iOS which the contact is using." + }, + { + "key": "ios_sdk_version", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The version of the iOS SDK which the contact is using." + }, + { + "key": "ios_last_seen_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "(UNIX timestamp) The last time the contact used the iOS app." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "object", + "extends": [], + "properties": [] + }, + "description": "The custom attributes which are set for the contact." + }, + { + "key": "avatar", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of object" + }, + { + "key": "image_url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "An image URL containing the avatar of a contact." + } + ] + } + } + } + }, + { + "key": "tags", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_tags" + } + } + }, + { + "key": "notes", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_notes" + } + } + }, + { + "key": "companies", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_companies" + } + } + }, + { + "key": "location", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_location" + } + } + }, + { + "key": "social_profiles", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_social_profiles" + } + } + } + ] + }, + "description": "Contact are the objects that represent your leads and users in Intercom." + }, + "contact_archived": { + "name": "Contact Archived", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + } + ] + }, + "description": "always contact" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact is archived or not." + } + ] + }, + "description": "archived contact object" + }, + "contact_attached_companies": { + "name": "Contact Attached Companies", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of object" + }, + { + "key": "companies", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + } + } + }, + "description": "An array containing Company Objects" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of companies associated to this contact" + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "pages_link" + } + } + } + ] + }, + "description": "A list of Company Objects" + }, + "contact_companies": { + "name": "Contact companies", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "Url to get more company resources for this contact" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Int representing the total number of companyies attached to this contact" + }, + { + "key": "has_more", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all" + } + ] + }, + "description": "An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more." + }, + "contact_deleted": { + "name": "Contact Deleted", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + } + ] + }, + "description": "always contact" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + }, + { + "key": "deleted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact is deleted or not." + } + ] + }, + "description": "deleted contact object" + }, + "contact_list": { + "name": "Contact List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "Always list" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact" + } + } + } + }, + "description": "The list of contact objects" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of objects." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "Contacts are your users in Intercom." + }, + "contact_location": { + "name": "Contact Location", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Always location" + }, + { + "key": "country", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The country that the contact is located in" + }, + { + "key": "region", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The overal region that the contact is located in" + }, + { + "key": "city", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The city that the contact is located in" + } + ] + }, + "description": "An object containing location meta data about a Intercom contact." + }, + "contact_notes": { + "name": "Contact notes", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "addressable_list" + } + } + } + }, + "description": "This object represents the notes attached to a contact." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "Url to get more company resources for this contact" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Int representing the total number of companyies attached to this contact" + }, + { + "key": "has_more", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all" + } + ] + }, + "description": "An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more." + }, + "contact_reference": { + "name": "Contact Reference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + } + ] + }, + "description": "always contact" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + } + ] + }, + "description": "reference to contact object" + }, + "contact_reply_base_request": { + "name": "Contact Reply Base Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "comment" + } + ] + } + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "user" + } + ] + } + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The text body of the comment." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time the reply was created. If not provided, the current time will be used." + }, + { + "key": "attachment_urls", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + } + } + }, + "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs." + } + ] + } + }, + "contact_reply_conversation_request": { + "name": "Contact Reply", + "shape": { + "type": "undiscriminatedUnion", + "variants": [] + } + }, + "contact_reply_email_request": { + "name": "Email", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email you have defined for the user." + }, + { + "key": "attachment_files", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_attachment_files" + } + } + } + } + } + }, + "description": "A list of files that will be added as attachments." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `email`" + }, + "contact_reply_intercom_user_id_request": { + "name": "Intercom User ID", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + }, + { + "key": "attachment_files", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_attachment_files" + } + } + } + } + } + }, + "description": "A list of files that will be added as attachments." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`" + }, + "contact_reply_ticket_email_request": { + "name": "Email", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email you have defined for the user." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `email`" + }, + "contact_reply_ticket_intercom_user_id_request": { + "name": "Intercom User ID", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`" + }, + "contact_reply_ticket_request": { + "name": "Contact Reply on ticket", + "shape": { + "type": "undiscriminatedUnion", + "variants": [] + } + }, + "contact_reply_ticket_user_id_request": { + "name": "User ID", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The external_id you have defined for the contact." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `user_id`" + }, + "contact_reply_user_id_request": { + "name": "User ID", + "shape": { + "type": "object", + "extends": [ + "contact_reply_base_request" + ], + "properties": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The external_id you have defined for the contact." + }, + { + "key": "attachment_files", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_attachment_files" + } + } + } + } + } + }, + "description": "A list of files that will be added as attachments. You can include up to 10 files." + } + ] + }, + "description": "Payload of the request to reply on behalf of a contact using their `user_id`" + }, + "contact_segments": { + "name": "Segments", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "segment" + } + } + } + }, + "description": "Segment objects associated with the contact." + } + ] + }, + "description": "A list of segments objects attached to a specific contact." + }, + "contact_social_profiles": { + "name": "Social Profile", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "social_profile" + } + } + } + }, + "description": "A list of social profiles objects associated with the contact." + } + ] + }, + "description": "An object containing social profiles that a contact has." + }, + "contact_subscription_types": { + "name": "Contact Subscription Types", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "addressable_list" + } + } + } + }, + "description": "This object represents the subscriptions attached to a contact." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "Url to get more subscription type resources for this contact" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Int representing the total number of subscription types attached to this contact" + }, + { + "key": "has_more", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all" + } + ] + }, + "description": "An object containing Subscription Types meta data about the SubscriptionTypes that a contact has." + }, + "contact_tags": { + "name": "Contact Tags", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "addressable_list" + } + } + } + }, + "description": "This object represents the tags attached to a contact." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "url to get more tag resources for this contact" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Int representing the total number of tags attached to this contact" + }, + { + "key": "has_more", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all" + } + ] + } + } + }, + "description": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more." + }, + "contact_unarchived": { + "name": "Contact Unarchived", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + } + ] + }, + "description": "always contact" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact which is given by Intercom." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The unique identifier for the contact which is provided by the Client." + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the contact is archived or not." + } + ] + }, + "description": "unarchived contact object" + }, + "content_source": { + "name": "Content Source", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "file" + }, + { + "value": "article" + }, + { + "value": "external_content" + }, + { + "value": "content_snippet" + }, + { + "value": "workflow_connector_action" + } + ] + }, + "description": "The type of the content source." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The internal URL linking to the content source for teammates." + }, + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the content source." + }, + { + "key": "locale", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ISO 639 language code of the content source." + } + ] + }, + "description": "The content source used by AI Agent in the conversation." + }, + "content_sources_list": { + "name": "Content Source List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "content_source.list" + } + ] + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of content sources used by AI Agent in the conversation." + }, + { + "key": "content_sources", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "content_source" + } + } + } + }, + "description": "The content sources used by AI Agent in the conversation." + } + ] + } + }, + "conversation": { + "name": "Conversation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Always conversation." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the conversation." + }, + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The title given to the conversation." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the conversation was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the conversation was updated." + }, + { + "key": "waiting_since", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin." + }, + { + "key": "snoozed_until", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time." + }, + { + "key": "open", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether a conversation is open (true) or closed (false)." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "open" + }, + { + "value": "closed" + }, + { + "value": "snoozed" + } + ] + }, + "description": "Can be set to \"open\", \"closed\" or \"snoozed\"." + }, + { + "key": "read", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether a conversation has been read." + }, + { + "key": "priority", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "priority" + }, + { + "value": "not_priority" + } + ] + }, + "description": "If marked as priority, it will return priority or else not_priority." + }, + { + "key": "admin_assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null." + }, + { + "key": "team_assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The id of the team assigned to the conversation. If it's not assigned to a team it will return null." + }, + { + "key": "tags", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "tags" + } + } + }, + { + "key": "conversation_rating", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_rating" + } + } + }, + { + "key": "source", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_source" + } + } + }, + { + "key": "contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_contacts" + } + } + }, + { + "key": "teammates", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_teammates" + } + } + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "custom_attributes" + } + } + }, + { + "key": "first_contact_reply", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_first_contact_reply" + } + } + }, + { + "key": "sla_applied", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "sla_applied" + } + } + }, + { + "key": "statistics", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_statistics" + } + } + }, + { + "key": "conversation_parts", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_parts" + } + } + }, + { + "key": "linked_objects", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "linked_object_list" + } + } + }, + { + "key": "ai_agent_participated", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Indicates whether the AI Agent participated in the conversation." + }, + { + "key": "ai_agent", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "ai_agent" + } + } + } + } + } + ] + }, + "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact." + }, + "conversation_attachment_files": { + "name": "Conversation attachment files", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "content_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The content type of the file" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The base64 encoded file data." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the file." + } + ] + }, + "description": "Properties of the attachment files in a conversation part" + }, + "conversation_contacts": { + "name": "Contacts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact.list" + } + ] + }, + "description": "" + }, + { + "key": "contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_reference" + } + } + } + }, + "description": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature." + } + ] + }, + "description": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature." + }, + "conversation_first_contact_reply": { + "name": "First contact reply", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "" + }, + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "" + } + ] + } + } + }, + "description": "An object containing information on the first users message. For a contact initiated message this will represent the users original message." + }, + "conversation_list": { + "name": "Conversation List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "conversation.list" + } + ] + }, + "description": "Always conversation.list" + }, + { + "key": "conversations", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation" + } + } + } + }, + "description": "The list of conversation objects" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of objects." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact." + }, + "conversation_part": { + "name": "Conversation Part", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Always conversation_part" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the conversation part." + }, + { + "key": "part_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of conversation part." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the conversation part was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the conversation part was updated." + }, + { + "key": "notified_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the user was notified with the conversation part." + }, + { + "key": "assigned_to", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "reference" + } + } + } + }, + "description": "The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)" + }, + { + "key": "author", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_part_author" + } + } + }, + { + "key": "attachments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "part_attachment" + } + } + } + }, + "description": "A list of attachments for the part." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The external id of the conversation part" + }, + { + "key": "redacted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the conversation part has been redacted." + } + ] + }, + "description": "A Conversation Part represents a message in the conversation." + }, + "conversation_part_author": { + "name": "Conversation part author", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the author" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the author" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the author" + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "email" + } + } + }, + "description": "The email of the author" + } + ] + }, + "description": "The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank." + }, + "conversation_parts": { + "name": "Conversation Parts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "conversation_part.list" + } + ] + }, + "description": "" + }, + { + "key": "conversation_parts", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_part" + } + } + } + }, + "description": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts." + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "" + } + ] + }, + "description": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts." + }, + "conversation_rating": { + "name": "Conversation Rating", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "rating", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The rating, between 1 and 5, for the conversation." + }, + { + "key": "remark", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "An optional field to add a remark to correspond to the number rating" + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the rating was requested in the conversation being rated." + }, + { + "key": "contact", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_reference" + } + } + }, + { + "key": "teammate", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "reference" + } + } + } + ] + } + } + }, + "description": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation." + }, + "conversation_source": { + "name": "Conversation source", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the message." + }, + { + "key": "delivered_as", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email)." + }, + { + "key": "subject", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured." + }, + { + "key": "author", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "conversation_part_author" + } + } + }, + { + "key": "attachments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "part_attachment" + } + } + } + }, + "description": "A list of attachments for the part." + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank." + }, + { + "key": "redacted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the source message has been redacted. Only applicable for contact initiated messages." + } + ] + }, + "description": "The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated." + }, + "conversation_statistics": { + "name": "Conversation statistics", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "time_to_assignment", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Duration until last assignment before first admin reply. In seconds." + }, + { + "key": "time_to_admin_reply", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Duration until first admin reply. Subtracts out of business hours. In seconds." + }, + { + "key": "time_to_first_close", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Duration until conversation was closed first time. Subtracts out of business hours. In seconds." + }, + { + "key": "time_to_last_close", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Duration until conversation was closed last time. Subtracts out of business hours. In seconds." + }, + { + "key": "median_time_to_reply", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds." + }, + { + "key": "first_contact_reply_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of first text conversation part from a contact." + }, + { + "key": "first_assignment_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of first assignment after first_contact_reply_at." + }, + { + "key": "first_admin_reply_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of first admin reply after first_contact_reply_at." + }, + { + "key": "first_close_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of first close after first_contact_reply_at." + }, + { + "key": "last_assignment_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of last assignment after first_contact_reply_at." + }, + { + "key": "last_assignment_admin_reply_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of first admin reply since most recent assignment." + }, + { + "key": "last_contact_reply_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of the last conversation part from a contact." + }, + { + "key": "last_admin_reply_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of the last conversation part from an admin." + }, + { + "key": "last_close_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Time of the last conversation close." + }, + { + "key": "last_closed_by_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The last admin who closed the conversation. Returns a reference to an Admin object." + }, + { + "key": "count_reopens", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of reopens after first_contact_reply_at." + }, + { + "key": "count_assignments", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of assignments after first_contact_reply_at." + }, + { + "key": "count_conversation_parts", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Total number of conversation parts." + } + ] + } + } + }, + "description": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics." + }, + "conversation_teammates": { + "name": "Conversation teammates", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the object - `admin.list`." + }, + { + "key": "teammates", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "reference" + } + } + } + }, + "description": "The list of teammates who participated in the conversation (wrote at least one conversation part)." + } + ] + } + } + }, + "description": "The list of teammates who participated in the conversation (wrote at least one conversation part)." + }, + "convert_conversation_to_ticket_request": { + "name": "Convert Ticket Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "ticket_type_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the type of ticket you want to convert the conversation to" + }, + { + "key": "attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_request_custom_attributes" + } + } + } + } + } + ] + }, + "description": "You can convert a Conversation to a Ticket" + }, + "convert_visitor_request": { + "name": "Convert Visitor Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Represents the role of the Contact model. Accepts `lead` or `user`." + } + ] + }, + "description": "You can merge a Visitor to a Contact of role type lead or user." + }, + "create_article_request": { + "name": "Create Article Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the article.For multilingual articles, this will be the title of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The description of the article. For multilingual articles, this will be the description of the default language's content." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The content of the article. For multilingual articles, this will be the body of the default language's content." + }, + { + "key": "author_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace." + }, + { + "key": "state", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "enum", + "values": [ + { + "value": "published" + }, + { + "value": "draft" + } + ] + } + } + }, + "description": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content." + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of the article's parent collection or section. An article without this field stands alone." + }, + { + "key": "parent_type", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The type of parent, which can either be a `collection` or `section`." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_translated_content" + } + } + } + } + } + ] + } + } + }, + "description": "You can create an Article" + }, + "create_collection_request": { + "name": "Create Collection Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The description of the collection. For multilingual collections, this will be the description of the default language's content." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_translated_content" + } + } + } + } + } + } + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "The id of the parent collection. If `null` then it will be created as the first level collection." + }, + { + "key": "help_center_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + } + } + }, + "description": "The id of the help center where the collection will be created. If `null` then it will be created in the default help center." + } + ] + }, + "description": "You can create a collection" + }, + "create_conversation_request": { + "name": "Create Conversation Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "from", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "lead" + }, + { + "value": "user" + }, + { + "value": "contact" + } + ] + }, + "description": "The role associated to the contact - user or lead." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid", + "minLength": 24, + "maxLength": 24 + } + } + }, + "description": "The identifier for the contact which is given by Intercom." + } + ] + } + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The content of the message. HTML is not supported." + } + ] + }, + "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact." + }, + "create_data_attribute_request": { + "name": "Create Data Attribute Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the data attribute." + }, + { + "key": "model", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + }, + { + "value": "company" + } + ] + }, + "description": "The model that the data attribute belongs to." + }, + { + "key": "data_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "string" + }, + { + "value": "integer" + }, + { + "value": "float" + }, + { + "value": "boolean" + }, + { + "value": "datetime" + }, + { + "value": "date" + } + ] + }, + "description": "The type of data stored for this attribute." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The readable description you see in the UI for the attribute." + }, + { + "key": "options", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "To create list attributes. Provide a set of hashes with `value` as the key of the options you want to make. `data_type` must be `string`." + }, + { + "key": "messenger_writable", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Can this attribute be updated by the Messenger" + } + ] + }, + "description": "" + }, + "create_data_event_summaries_request": { + "name": "Create Data Event Summaries Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Your identifier for the user." + }, + { + "key": "event_summaries", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "event_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`." + }, + { + "key": "count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of times the event occurred." + }, + { + "key": "first", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the event was sent" + }, + { + "key": "last", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the event was sent" + } + ] + }, + "description": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`." + } + ] + }, + "description": "You can send a list of event summaries for a user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense \"verb-noun\" combination, to improve readability, for example `updated-plan`." + }, + "create_data_exports_request": { + "name": "Create Data Export Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "created_at_after", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The start date that you request data for. It must be formatted as a unix timestamp." + }, + { + "key": "created_at_before", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The end date that you request data for. It must be formatted as a unix timestamp." + } + ] + }, + "description": "Request for creating a data export" + }, + "create_or_update_company_request": { + "name": "Create Or Update Company Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Company" + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The company id you have defined for the company. Can't be updated" + }, + { + "key": "plan", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the plan you have associated with the company." + }, + { + "key": "size", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of employees in this company." + }, + { + "key": "website", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL for this company's website. Please note that the value specified here is not validated. Accepts any string." + }, + { + "key": "industry", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The industry that this company operates in." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "A hash of key/value pairs containing any other data about the company you want Intercom to store." + }, + { + "key": "remote_created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the company was created by you." + }, + { + "key": "monthly_spend", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647.." + } + ] + } + } + }, + "description": "You can create or update a Company" + }, + "create_or_update_tag_request": { + "name": "Create or Update Tag Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The id of tag to updates." + } + ] + }, + "description": "You can create or update an existing tag." + }, + "create_phone_switch_request": { + "name": "Create Phone Switch Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "phone", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "custom_attributes" + } + } + } + } + } + ] + } + } + }, + "description": "You can create an phone switch" + }, + "create_ticket_reply_with_comment_request": { + "name": "Create Ticket Reply Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_reply_ticket_request" + } + } + }, + "create_ticket_request": { + "name": "Create Ticket Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "ticket_type_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the type of ticket you want to create" + }, + { + "key": "contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + } + ] + } + } + }, + "description": "The list of contacts (users or leads) affected by this ticket. Currently only one is allowed" + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The ID of the company that the ticket is associated with. The ID that you set upon company creation." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time the ticket was created. If not provided, the current time will be used." + }, + { + "key": "ticket_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_request_custom_attributes" + } + } + } + } + } + ] + }, + "description": "You can create a Ticket" + }, + "create_ticket_type_attribute_request": { + "name": "Create Ticket Type Attribute Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type attribute" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the attribute presented to the teammate or contact" + }, + { + "key": "data_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "string" + }, + { + "value": "list" + }, + { + "value": "integer" + }, + { + "value": "decimal" + }, + { + "value": "boolean" + }, + { + "value": "datetime" + }, + { + "value": "files" + } + ] + }, + "description": "The data type of the attribute" + }, + { + "key": "required_to_create", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + } + } + }, + "description": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox." + }, + { + "key": "required_to_create_for_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + } + } + }, + "description": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger." + }, + { + "key": "visible_on_create", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + } + } + }, + "description": "Whether the attribute is visible to teammates when creating a ticket in Inbox." + }, + { + "key": "visible_to_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + } + } + }, + "description": "Whether the attribute is visible to contacts when creating a ticket in Messenger." + }, + { + "key": "multiline", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Whether the attribute allows multiple lines of text (only applicable to string attributes)" + }, + { + "key": "list_items", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "A comma delimited list of items for the attribute value (only applicable to list attributes)" + }, + { + "key": "allow_multiple_values", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)" + } + ] + }, + "description": "You can create a Ticket Type Attribute" + }, + "create_ticket_type_request": { + "name": "Create Ticket Type Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The description of the ticket type." + }, + { + "key": "category", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "enum", + "values": [ + { + "value": "Customer" + }, + { + "value": "Back-office" + }, + { + "value": "Tracker" + } + ] + } + } + }, + "description": "Category of the Ticket Type." + }, + { + "key": "icon", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "🎟️" + } + } + } + } + }, + "description": "The icon of the ticket type." + }, + { + "key": "is_internal", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + } + } + }, + "description": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute." + } + ] + } + } + }, + "description": "The request payload for creating a ticket type.\n You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + }, + "cursor_pages": { + "name": "Cursor based pages", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "pages" + } + ] + }, + "description": "the type of object `pages`." + }, + { + "key": "page", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The current page" + }, + { + "key": "next", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "starting_after_paging" + } + } + }, + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Number of results per page" + }, + { + "key": "total_pages", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Total number of pages" + } + ] + } + } + }, + "description": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data.\nA \"cursor\" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or \"pages\" as needed.\n" + }, + "custom_attributes": { + "name": "Custom Attributes", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models." + }, + "custom_object_instance": { + "name": "Custom Object Instance", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the custom object instance." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id you have defined for the custom object instance." + }, + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier of the custom object type that defines the structure of the custom object instance." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The custom attributes you have set on the custom object instance." + } + ] + } + } + }, + "description": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes." + }, + "customer_request": { + "name": "customer_request", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for the contact as given by Intercom." + } + ] + } + } + } + }, + "data_attribute": { + "name": "Data Attribute", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "data_attribute" + } + ] + }, + "description": "Value is `data_attribute`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes." + }, + { + "key": "model", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + }, + { + "value": "company" + } + ] + }, + "description": "Value is `contact` for user/lead attributes and `company` for company attributes." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Name of the attribute." + }, + { + "key": "full_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on `.` to access nested user object values." + }, + { + "key": "label", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Readable name of the attribute (i.e. name you see in the UI)" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Readable description of the attribute." + }, + { + "key": "data_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "string" + }, + { + "value": "integer" + }, + { + "value": "float" + }, + { + "value": "boolean" + }, + { + "value": "date" + } + ] + }, + "description": "The data type of the attribute." + }, + { + "key": "options", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "List of predefined options for attribute value." + }, + { + "key": "api_writable", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Can this attribute be updated through API" + }, + { + "key": "messenger_writable", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Can this attribute be updated by the Messenger" + }, + { + "key": "ui_writable", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Can this attribute be updated in the UI" + }, + { + "key": "custom", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Set to true if this is a CDA" + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Is this attribute archived. (Only applicable to CDAs)" + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the attribute was created as a UTC Unix timestamp" + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the attribute was last updated as a UTC Unix timestamp" + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Teammate who created the attribute. Only applicable to CDAs" + } + ] + }, + "description": "Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes." + }, + "data_attribute_list": { + "name": "Data Attribute List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "data_attribute" + } + } + } + }, + "description": "A list of data attributes" + } + ] + }, + "description": "A list of all data attributes belonging to a workspace for contacts, companies or conversations." + }, + "data_event": { + "name": "Data Event", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "enum", + "values": [ + { + "value": "event" + } + ] + } + } + }, + "description": "The type of the object" + }, + { + "key": "event_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the event occurred as a UTC Unix timestamp" + }, + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Your identifier for the user." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "Your identifier for a lead or a user." + }, + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The Intercom identifier for the user." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "An email address for your user. An email should only be used where your application uses email to uniquely identify users." + }, + { + "key": "metadata", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Optional metadata about the event." + } + ] + }, + "description": "Data events are used to notify Intercom of changes to your data." + }, + "data_event_list": { + "name": "Data Event List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "event.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "events", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "data_event" + } + } + } + }, + "description": "A list of data events" + }, + { + "key": "pages", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "next", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "since", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + }, + "description": "Pagination" + } + ] + }, + "description": "This will return a list of data events for the App." + }, + "data_event_summary": { + "name": "Data Event Summary", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "event.summary" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The email address of the user" + }, + { + "key": "intercom_user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom user ID of the user" + }, + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The user ID of the user" + }, + { + "key": "events", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "data_event_summary_item" + } + } + } + }, + "description": "A summary of data events" + } + ] + }, + "description": "This will return a summary of data events for the App." + }, + "data_event_summary_item": { + "name": "Data Event Summary Item", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the event" + }, + { + "key": "first", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The first time the event was sent" + }, + { + "key": "last", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The last time the event was sent" + }, + { + "key": "count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of times the event was sent" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the event" + } + ] + } + } + }, + "description": "This will return a summary of a data event for the App." + }, + "data_export": { + "name": "Data Export", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "job_identfier", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier for your job." + }, + { + "key": "status", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "pending" + }, + { + "value": "in_progress" + }, + { + "value": "failed" + }, + { + "value": "completed" + }, + { + "value": "no_data" + }, + { + "value": "canceled" + } + ] + }, + "description": "The current state of your job." + }, + { + "key": "download_expires_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The time after which you will not be able to access the data." + }, + { + "key": "download_url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The location where you can download your data." + } + ] + }, + "description": "The data export api is used to view all message sent & viewed in a given timeframe." + }, + "data_export_csv": { + "name": "Data Export CSV", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The user_id of the user who was sent the message." + }, + { + "key": "user_external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The external_user_id of the user who was sent the message" + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The company ID of the user in relation to the message that was sent. Will return -1 if no company is present." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The users email who was sent the message." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The full name of the user receiving the message" + }, + { + "key": "ruleset_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the message." + }, + { + "key": "content_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The specific content that was received. In an A/B test each version has its own Content ID." + }, + { + "key": "content_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Email, Chat, Post etc." + }, + { + "key": "content_title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the content you see in your Intercom workspace." + }, + { + "key": "ruleset_version_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received." + }, + { + "key": "receipt_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message." + }, + { + "key": "received_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Timestamp for when the receipt was recorded." + }, + { + "key": "series_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the series that this content is part of. Will return -1 if not part of a series." + }, + { + "key": "series_title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the series that this content is part of." + }, + { + "key": "node_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id." + }, + { + "key": "first_reply", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time a user replied to this message if the content was able to receive replies." + }, + { + "key": "first_completion", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys." + }, + { + "key": "first_series_completion", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the series this message was a part of was completed by the user." + }, + { + "key": "first_series_disengagement", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the series this message was a part of was disengaged by the user." + }, + { + "key": "first_series_exit", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the series this message was a part of was exited by the user." + }, + { + "key": "first_goal_success", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the user met this messages associated goal if one exists." + }, + { + "key": "first_open", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the user opened this message." + }, + { + "key": "first_click", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the series the user clicked on a link within this message." + }, + { + "key": "first_dismisall", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the series the user dismissed this message." + }, + { + "key": "first_unsubscribe", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time the user unsubscribed from this message." + }, + { + "key": "first_hard_bounce", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The first time this message hard bounced for this user" + } + ] + }, + "description": "A CSV output file" + }, + "deleted_article_object": { + "name": "Deleted Article Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the article which you provided in the URL." + }, + { + "key": "object", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "article" + } + ] + }, + "description": "The type of object which was deleted. - article" + }, + { + "key": "deleted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the article was deleted successfully or not." + } + ] + }, + "description": "Response returned when an object is deleted" + }, + "deleted_collection_object": { + "name": "Deleted Collection Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the collection which you provided in the URL." + }, + { + "key": "object", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "collection" + } + ] + }, + "description": "The type of object which was deleted. - `collection`" + }, + { + "key": "deleted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the collection was deleted successfully or not." + } + ] + }, + "description": "Response returned when an object is deleted" + }, + "deleted_company_object": { + "name": "Deleted Company Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the company which is given by Intercom." + }, + { + "key": "object", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "company" + } + ] + }, + "description": "The type of object which was deleted. - `company`" + }, + { + "key": "deleted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the company was deleted successfully or not." + } + ] + }, + "description": "Response returned when an object is deleted" + }, + "deleted_object": { + "name": "Deleted Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the news item which you provided in the URL." + }, + { + "key": "object", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "news-item" + } + ] + }, + "description": "The type of object which was deleted - news-item." + }, + { + "key": "deleted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the news item was deleted successfully or not." + } + ] + }, + "description": "Response returned when an object is deleted" + }, + "detach_contact_from_conversation_request": { + "name": "detach_contact_from_conversation_request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The `id` of the admin who is performing the action." + } + ] + } + }, + "error": { + "name": "Error", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type is error.list" + }, + { + "key": "request_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + } + } + } + }, + "description": "" + }, + { + "key": "errors", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "code", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A string indicating the kind of error, used to further qualify the HTTP response code" + }, + { + "key": "message", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Optional. Human readable description of the error." + }, + { + "key": "field", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Optional. Used to identify a particular field or query parameter that was in error." + } + ] + } + } + }, + "description": "An array of one or more error objects" + } + ] + }, + "description": "The API will return an Error List for a failed request, which will contain one or more Error objects." + }, + "file_attribute": { + "name": "File", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the file" + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The url of the file. This is a temporary URL and will expire after 30 minutes." + }, + { + "key": "content_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of file" + }, + { + "key": "filesize", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The size of the file in bytes" + }, + { + "key": "width", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The width of the file in pixels, if applicable" + }, + { + "key": "height", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The height of the file in pixels, if applicable" + } + ] + }, + "description": "The value describing a file upload set for a custom attribute" + }, + "group_content": { + "name": "Group Content", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [] + } + } + }, + "description": "The type of object - `group_content` ." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the collection or section." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the collection. Only available for collections." + } + ] + } + } + }, + "description": "The Content of a Group." + }, + "group_translated_content": { + "name": "Group Translated Content", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [] + } + } + }, + "description": "The type of object - group_translated_content." + }, + { + "key": "ar", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Arabic" + }, + { + "key": "bg", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Bulgarian" + }, + { + "key": "bs", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Bosnian" + }, + { + "key": "ca", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Catalan" + }, + { + "key": "cs", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Czech" + }, + { + "key": "da", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Danish" + }, + { + "key": "de", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in German" + }, + { + "key": "el", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Greek" + }, + { + "key": "en", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in English" + }, + { + "key": "es", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Spanish" + }, + { + "key": "et", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Estonian" + }, + { + "key": "fi", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Finnish" + }, + { + "key": "fr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in French" + }, + { + "key": "he", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Hebrew" + }, + { + "key": "hr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Croatian" + }, + { + "key": "hu", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Hungarian" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Indonesian" + }, + { + "key": "it", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Italian" + }, + { + "key": "ja", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Japanese" + }, + { + "key": "ko", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Korean" + }, + { + "key": "lt", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Lithuanian" + }, + { + "key": "lv", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Latvian" + }, + { + "key": "mn", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Mongolian" + }, + { + "key": "nb", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Norwegian" + }, + { + "key": "nl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Dutch" + }, + { + "key": "pl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Polish" + }, + { + "key": "pt", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Portuguese (Portugal)" + }, + { + "key": "ro", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Romanian" + }, + { + "key": "ru", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Russian" + }, + { + "key": "sl", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Slovenian" + }, + { + "key": "sr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Serbian" + }, + { + "key": "sv", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Swedish" + }, + { + "key": "tr", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Turkish" + }, + { + "key": "vi", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Vietnamese" + }, + { + "key": "pt-BR", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Portuguese (Brazil)" + }, + { + "key": "zh-CN", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Chinese (China)" + }, + { + "key": "zh-TW", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_content" + } + }, + "description": "The content of the group in Chinese (Taiwan)" + } + ] + } + } + }, + "description": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group." + }, + "help_center": { + "name": "Help Center", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the Help Center which is given by Intercom." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace which the Help Center belongs to." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the Help Center was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the Help Center was last updated." + }, + { + "key": "identifier", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The identifier of the Help Center. This is used in the URL of the Help Center." + }, + { + "key": "website_turned_on", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the Help Center is turned on or not. This is controlled in your Help Center settings." + }, + { + "key": "display_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The display name of the Help Center only seen by teammates." + } + ] + }, + "description": "Help Centers contain collections" + }, + "help_center_list": { + "name": "Help Centers", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object - `list`." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "help_center" + } + } + } + }, + "description": "An array of Help Center objects" + } + ] + }, + "description": "A list of Help Centers belonging to the App" + }, + "intercom_version": { + "name": "intercom_version", + "shape": { + "type": "enum", + "values": [ + { + "value": "1.0" + }, + { + "value": "1.1" + }, + { + "value": "1.2" + }, + { + "value": "1.3" + }, + { + "value": "1.4" + }, + { + "value": "2.0" + }, + { + "value": "2.1" + }, + { + "value": "2.2" + }, + { + "value": "2.3" + }, + { + "value": "2.4" + }, + { + "value": "2.5" + }, + { + "value": "2.6" + }, + { + "value": "2.7" + }, + { + "value": "2.8" + }, + { + "value": "2.9" + }, + { + "value": "2.10" + }, + { + "value": "2.11" + }, + { + "value": "Unstable" + } + ], + "default": "2.11" + }, + "description": "Intercom API version.
By default, it's equal to the version set in the app package." + }, + "linked_object": { + "name": "Linked Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "ticket" + }, + { + "value": "conversation" + } + ] + }, + "description": "ticket or conversation" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the linked object" + }, + { + "key": "category", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "enum", + "values": [ + { + "value": "Customer" + }, + { + "value": "Back-office" + }, + { + "value": "Tracker" + } + ] + } + } + }, + "description": "Category of the Linked Ticket Object." + } + ] + }, + "description": "A linked conversation or ticket." + }, + "linked_object_list": { + "name": "Linked Objects", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "Always list." + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The total number of linked objects." + }, + { + "key": "has_more", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not there are more linked objects than returned." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "linked_object" + } + } + } + }, + "description": "An array containing the linked conversations and linked tickets." + } + ] + }, + "description": "An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned." + }, + "merge_contacts_request": { + "name": "Merge contact data", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "from", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact to merge away from. Must be a lead." + }, + { + "key": "into", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the contact to merge into. Must be a user." + } + ] + }, + "description": "Merge contact data." + }, + "message": { + "name": "Message", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the message" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the message." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the conversation was created." + }, + { + "key": "subject", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The subject of the message. Only present if message_type: email." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The message body, which may contain HTML." + }, + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "email" + }, + { + "value": "inapp" + }, + { + "value": "facebook" + }, + { + "value": "twitter" + } + ] + }, + "description": "The type of message that was sent. Can be email, inapp, facebook or twitter." + }, + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The associated conversation_id" + } + ] + }, + "description": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact." + }, + "multiple_filter_search_request": { + "name": "Multiple Filter Search Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "operator", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "AND" + }, + { + "value": "OR" + } + ] + }, + "description": "An operator to allow boolean inspection between multiple fields." + }, + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "multiple_filter_search_request" + } + } + } + } + } + ] + }, + "description": "Search using Intercoms Search APIs with more than one filter." + }, + "news_item": { + "name": "News Item", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "news-item" + } + ] + }, + "description": "The type of object." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the news item which is given by Intercom." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace which the news item belongs to." + }, + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the news item." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The news item body, which may contain HTML." + }, + { + "key": "sender_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the sender of the news item. Must be a teammate on the workspace." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "draft" + }, + { + "value": "live" + } + ] + }, + "description": "News items will not be visible to your users in the assigned newsfeeds until they are set live." + }, + { + "key": "newsfeed_assignments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "newsfeed_assignment" + } + } + } + }, + "description": "A list of newsfeed_assignments to assign to the specified newsfeed." + }, + { + "key": "labels", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Label names displayed to users to categorize the news item." + }, + { + "key": "cover_image_url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "URL of the image used as cover. Must have .jpg or .png extension." + }, + { + "key": "reactions", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled." + }, + { + "key": "deliver_silently", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "When set to true, the news item will appear in the messenger newsfeed without showing a notification badge." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Timestamp for when the news item was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Timestamp for when the news item was last updated." + } + ] + }, + "description": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers." + }, + "news_item_request": { + "name": "Create News Item Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the news item." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The news item body, which may contain HTML." + }, + { + "key": "sender_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the sender of the news item. Must be a teammate on the workspace." + }, + { + "key": "state", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "enum", + "values": [ + { + "value": "draft" + }, + { + "value": "live" + } + ] + } + } + }, + "description": "News items will not be visible to your users in the assigned newsfeeds until they are set live." + }, + { + "key": "deliver_silently", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge." + }, + { + "key": "labels", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "Label names displayed to users to categorize the news item." + }, + { + "key": "reactions", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "description": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled." + }, + { + "key": "newsfeed_assignments", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "newsfeed_assignment" + } + } + } + } + } + }, + "description": "A list of newsfeed_assignments to assign to the specified newsfeed." + } + ] + }, + "description": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers." + }, + "newsfeed": { + "name": "Newsfeed", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the newsfeed which is given by Intercom." + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "newsfeed" + } + ] + }, + "description": "The type of object." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the newsfeed. This name will never be visible to your users." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Timestamp for when the newsfeed was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Timestamp for when the newsfeed was last updated." + } + ] + }, + "description": "A newsfeed is a collection of news items, targeted to a specific audience.\n\nNewsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom.\n" + }, + "newsfeed_assignment": { + "name": "Newsfeed Assignment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "newsfeed_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article)." + }, + { + "key": "published_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is \"draft\"." + } + ] + }, + "description": "Assigns a news item to a newsfeed." + }, + "note": { + "name": "Note", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `note`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the note." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the note was created." + }, + { + "key": "contact", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `contact`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the contact." + } + ] + } + } + }, + "description": "Represents the contact that the note was created about." + }, + { + "key": "author", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "admin" + } + }, + "description": "Optional. Represents the Admin that created the note." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The body text of the note." + } + ] + }, + "description": "Notes allow you to annotate and comment on your contacts." + }, + "note_list": { + "name": "Paginated Response", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `list`." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "note" + } + } + } + }, + "description": "An array of notes." + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of notes." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "A paginated list of notes associated with a contact." + }, + "open_conversation_request": { + "name": "Open Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "open" + } + ] + } + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is performing the action." + } + ] + }, + "description": "Payload of the request to open a conversation" + }, + "pages_link": { + "name": "Pagination Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "pages" + } + ] + } + }, + { + "key": "page", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "next", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch." + }, + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "total_pages", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + }, + "description": "The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.\n\nTheir responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.\n" + }, + "paginated_response": { + "name": "Paginated Response", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + }, + { + "value": "conversation.list" + } + ] + }, + "description": "The type of object" + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of objects." + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "undiscriminatedUnion", + "variants": [] + } + } + }, + "description": "An array of Objects" + } + ] + }, + "description": "Paginated Response" + }, + "part_attachment": { + "name": "Part attachment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of attachment" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the attachment" + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The URL of the attachment" + }, + { + "key": "content_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The content type of the attachment" + }, + { + "key": "filesize", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The size of the attachment" + }, + { + "key": "width", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The width of the attachment" + }, + { + "key": "height", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The height of the attachment" + } + ] + }, + "description": "The file attached to a part" + }, + "phone_switch": { + "name": "Phone Switch", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "phone_call_redirect" + } + ], + "default": "phone_call_redirect" + }, + "description": "" + }, + { + "key": "phone", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger." + } + ] + } + } + }, + "description": "Phone Switch Response" + }, + "redact_conversation_request": { + "name": "redact_conversation_request", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "displayName": "Redact Conversation Part Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "conversation_part" + } + ] + }, + "description": "The type of resource being redacted." + }, + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the conversation." + }, + { + "key": "conversation_part_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the conversation_part." + } + ] + }, + "description": "Payload of the request to redact a conversation part" + }, + { + "displayName": "Redact Conversation Source Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "source" + } + ] + }, + "description": "The type of resource being redacted." + }, + { + "key": "conversation_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the conversation." + }, + { + "key": "source_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the source." + } + ] + }, + "description": "Payload of the request to redact a conversation source" + } + ] + } + }, + "reference": { + "name": "Reference", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "" + } + ] + }, + "description": "reference to another object" + }, + "reply_conversation_request": { + "name": "reply_conversation_request", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_reply_conversation_request" + } + } + }, + "search_request": { + "name": "Search data", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "query", + "valueShape": { + "type": "undiscriminatedUnion", + "variants": [] + } + }, + { + "key": "pagination", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "starting_after_paging" + } + } + } + } + } + ] + }, + "description": "Search using Intercoms Search APIs." + }, + "segment": { + "name": "Segment", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "segment" + } + ] + }, + "description": "The type of object." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier representing the segment." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the segment." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the segment was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the segment was updated." + }, + { + "key": "person_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact" + }, + { + "value": "user" + } + ] + }, + "description": "Type of the contact: contact (lead) or user." + }, + { + "key": "count", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The number of items in the user segment. It's returned when `include_count=true` is included in the request." + } + ] + }, + "description": "A segment is a group of your contacts defined by the rules that you set." + }, + "segment_list": { + "name": "Segment List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "segment.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "segments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "segment" + } + } + } + }, + "description": "A list of Segment objects" + }, + { + "key": "pages", + "valueShape": { + "type": "object", + "extends": [], + "properties": [] + }, + "description": "A pagination object, which may be empty, indicating no further pages to fetch." + } + ] + }, + "description": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated." + }, + "single_filter_search_request": { + "name": "Single Filter Search Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "field", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The accepted field that you want to search on." + }, + { + "key": "operator", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "=" + }, + { + "value": "!=" + }, + { + "value": "IN" + }, + { + "value": "NIN" + }, + { + "value": "<" + }, + { + "value": ">" + }, + { + "value": "~" + }, + { + "value": "!~" + }, + { + "value": "^" + }, + { + "value": "$" + } + ] + }, + "description": "The accepted operators you can use to define how you want to search for the value." + }, + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The value that you want to search on." + } + ] + }, + "description": "Search using Intercoms Search APIs with a single filter." + }, + "sla_applied": { + "name": "Applied SLA", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "object type" + }, + { + "key": "sla_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the SLA as given by the teammate when it was created." + }, + { + "key": "sla_status", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "hit" + }, + { + "value": "missed" + }, + { + "value": "cancelled" + }, + { + "value": "active" + } + ] + }, + "description": "SLA statuses:\n - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.\n - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies.\n - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events." + } + ] + } + } + }, + "description": "The SLA Applied object contains the details for which SLA has been applied to this conversation.\nImportant: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.\n" + }, + "snooze_conversation_request": { + "name": "Snooze Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "message_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "snoozed" + } + ] + } + }, + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the admin who is performing the action." + }, + { + "key": "snoozed_until", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time you want the conversation to reopen." + } + ] + }, + "description": "Payload of the request to snooze a conversation" + }, + "social_profile": { + "name": "Social Profile", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "value is \"social_profile\"" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the Social media profile" + }, + { + "key": "url", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + }, + "description": "The name of the Social media profile" + } + ] + }, + "description": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile." + }, + "starting_after_paging": { + "name": "Pagination: Starting After", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "per_page", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of results to fetch per page." + }, + { + "key": "starting_after", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The cursor to use in the next request to get the next page of results." + } + ] + } + } + } + }, + "subscription_type": { + "name": "Subscription Types", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the object - subscription" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier representing the subscription type." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "live" + }, + { + "value": "draft" + }, + { + "value": "archived" + } + ] + }, + "description": "The state of the subscription type." + }, + { + "key": "default_translation", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "translation" + } + } + }, + { + "key": "translations", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "translation" + } + } + } + }, + "description": "An array of translations objects with the localised version of the subscription type in each available locale within your translation settings." + }, + { + "key": "consent_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "opt_out" + }, + { + "value": "opt_in" + } + ] + }, + "description": "Describes the type of consent." + }, + { + "key": "content_types", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "enum", + "values": [ + { + "value": "email" + }, + { + "value": "sms_message" + } + ] + } + } + }, + "description": "The message types that this subscription supports - can contain `email` or `sms_message`." + } + ] + }, + "description": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them." + }, + "subscription_type_list": { + "name": "Subscription Types", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "subscription_type" + } + } + } + }, + "description": "A list of subscription type objects associated with the workspace ." + } + ] + }, + "description": "A list of subscription type objects." + }, + "tag": { + "name": "Tag", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "value is \"tag\"" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the tag" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag" + }, + { + "key": "applied_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time when the tag was applied to the object" + }, + { + "key": "applied_by", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "reference" + } + } + } + ] + }, + "description": "A tag allows you to label your contacts, companies, and conversations and list them using that tag." + }, + "tag_company_request": { + "name": "Tag Company Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag, which will be created if not found." + }, + { + "key": "companies", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the company." + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The company id you have defined for the company." + } + ] + } + } + }, + "description": "The id or company_id of the company can be passed as input parameters." + } + ] + }, + "description": "You can tag a single company or a list of companies." + }, + "tag_list": { + "name": "Tags", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "data", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + } + } + }, + "description": "A list of tags objects associated with the workspace ." + } + ] + }, + "description": "A list of tags objects in the workspace." + }, + "tag_multiple_users_request": { + "name": "Tag Users Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag, which will be created if not found." + }, + { + "key": "users", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the user." + } + ] + } + } + } + } + ] + }, + "description": "You can tag a list of users." + }, + "tags": { + "name": "Tags", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "tag.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "tags", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "tag" + } + } + } + }, + "description": "A list of tags objects associated with the conversation." + } + ] + }, + "description": "A list of tags objects associated with a conversation" + }, + "team": { + "name": "Team", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Value is always \"team\"" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the team" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the team" + }, + { + "key": "admin_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The list of admin IDs that are a part of the team." + }, + { + "key": "admin_priority_level", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "admin_priority_level" + } + } + } + ] + }, + "description": "Teams are groups of admins in Intercom." + }, + "team_list": { + "name": "Team List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "team.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "teams", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "team" + } + } + } + }, + "description": "A list of team objects" + } + ] + }, + "description": "This will return a list of team objects for the App." + }, + "team_priority_level": { + "name": "Team Priority Level", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "primary_team_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The primary team ids for the team" + }, + { + "key": "secondary_team_ids", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The secondary team ids for the team" + } + ] + } + } + }, + "description": "Admin priority levels for teams" + }, + "ticket": { + "name": "Ticket", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "ticket" + } + ], + "default": "ticket" + }, + "description": "Always ticket" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the ticket which is given by Intercom." + }, + { + "key": "ticket_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries." + }, + { + "key": "category", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "Customer" + }, + { + "value": "Back-office" + }, + { + "value": "Tracker" + } + ] + }, + "description": "Category of the Ticket." + }, + { + "key": "ticket_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_custom_attributes" + } + } + }, + { + "key": "ticket_state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "submitted" + }, + { + "value": "in_progress" + }, + { + "value": "waiting_on_customer" + }, + { + "value": "resolved" + } + ] + }, + "description": "The state the ticket is currently in" + }, + { + "key": "ticket_type", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type" + } + } + }, + { + "key": "contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_contacts" + } + } + }, + { + "key": "admin_assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the admin assigned to the ticket." + }, + { + "key": "team_assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the team assigned to the ticket." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the ticket was created as a UTC Unix timestamp." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the ticket was updated as a UTC Unix timestamp." + }, + { + "key": "open", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the ticket is open. If false, the ticket is closed." + }, + { + "key": "snoozed_until", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed." + }, + { + "key": "linked_objects", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "linked_object_list" + } + } + }, + { + "key": "ticket_parts", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_parts" + } + } + }, + { + "key": "is_shared", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the ticket is shared with the customer." + }, + { + "key": "ticket_state_internal_label", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The state the ticket is currently in, in a human readable form - visible in Intercom" + }, + { + "key": "ticket_state_external_label", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal." + } + ] + } + } + }, + "description": "Tickets are how you track requests from your users." + }, + "ticket_contacts": { + "name": "Contacts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "contact.list" + } + ] + }, + "description": "always contact.list" + }, + { + "key": "contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "contact_reference" + } + } + } + }, + "description": "The list of contacts affected by this ticket." + } + ] + }, + "description": "The list of contacts affected by a ticket." + }, + "ticket_custom_attributes": { + "name": "Ticket Attributes", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are `_default_title_` and `_default_description_`." + }, + "ticket_list": { + "name": "Ticket List", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "ticket.list" + } + ] + }, + "description": "Always ticket.list" + }, + { + "key": "tickets", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket" + } + } + } + }, + "description": "The list of ticket objects" + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "A count of the total number of objects." + }, + { + "key": "pages", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "cursor_pages" + } + } + } + ] + }, + "description": "Tickets are how you track requests from your users." + }, + "ticket_part": { + "name": "Ticket Part", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Always ticket_part" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the ticket part." + }, + { + "key": "part_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of ticket part." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The message body, which may contain HTML." + }, + { + "key": "previous_ticket_state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "submitted" + }, + { + "value": "in_progress" + }, + { + "value": "waiting_on_customer" + }, + { + "value": "resolved" + } + ] + }, + "description": "The previous state of the ticket." + }, + { + "key": "ticket_state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "submitted" + }, + { + "value": "in_progress" + }, + { + "value": "waiting_on_customer" + }, + { + "value": "resolved" + } + ] + }, + "description": "The state of the ticket." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the ticket part was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the ticket part was updated." + }, + { + "key": "assigned_to", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "reference" + } + } + } + }, + "description": "The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)" + }, + { + "key": "author", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_part_author" + } + } + }, + { + "key": "attachments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "part_attachment" + } + } + } + }, + "description": "A list of attachments for the part." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The external id of the ticket part" + }, + { + "key": "redacted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the ticket part has been redacted." + } + ] + }, + "description": "A Ticket Part represents a message in the ticket." + }, + "ticket_part_author": { + "name": "Ticket part author", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "admin" + }, + { + "value": "bot" + }, + { + "value": "team" + }, + { + "value": "user" + } + ] + }, + "description": "The type of the author" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the author" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the author" + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "email" + } + } + }, + "description": "The email of the author" + } + ] + }, + "description": "The author that wrote or triggered the part. Can be a bot, admin, team or user." + }, + "ticket_parts": { + "name": "Ticket Parts", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "ticket_part.list" + } + ] + }, + "description": "" + }, + { + "key": "ticket_parts", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_part" + } + } + } + }, + "description": "A list of Ticket Part objects for each ticket. There is a limit of 500 parts." + }, + { + "key": "total_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "" + } + ] + }, + "description": "A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts." + }, + "ticket_reply": { + "name": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "ticket_part" + } + ] + }, + "description": "Always ticket_part" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the part." + }, + { + "key": "part_type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "note" + }, + { + "value": "comment" + }, + { + "value": "quick_reply" + } + ] + }, + "description": "Type of the part" + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The message body, which may contain HTML." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the note was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the note was updated." + }, + { + "key": "author", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_part_author" + } + } + }, + { + "key": "attachments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "part_attachment" + } + } + } + }, + "description": "A list of attachments for the part." + }, + { + "key": "redacted", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether or not the ticket part has been redacted." + } + ] + }, + "description": "A Ticket Part representing a note, comment, or quick_reply on a ticket" + }, + "ticket_request_custom_attributes": { + "name": "Ticket Attributes", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + }, + "description": "The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are `_default_title_` and `_default_description_`. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). For example, if the ticket type has an attribute called `priority` of type `list`, the key should be `priority` and the value of the attribute should be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`)." + }, + "ticket_type": { + "name": "Ticket Type", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `ticket_type`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the ticket type." + }, + { + "key": "category", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "Customer" + }, + { + "value": "Back-office" + }, + { + "value": "Tracker" + } + ] + }, + "description": "Category of the Ticket Type." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the ticket type" + }, + { + "key": "icon", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The icon of the ticket type" + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace that the ticket type belongs to." + }, + { + "key": "ticket_type_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type_attribute_list" + } + } + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the ticket type is archived or not." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The date and time the ticket type was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The date and time the ticket type was last updated." + } + ] + } + } + }, + "description": "A ticket type, used to define the data fields to be captured in a ticket." + }, + "ticket_type_attribute": { + "name": "Ticket Type Attribute", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `ticket_type_attribute`." + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id representing the ticket type attribute." + }, + { + "key": "workspace_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the workspace that the ticket type attribute belongs to." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type attribute" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the ticket type attribute" + }, + { + "key": "data_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of the data attribute (allowed values: \"string list integer decimal boolean datetime files\")" + }, + { + "key": "input_options", + "valueShape": { + "type": "object", + "extends": [], + "properties": [] + }, + "description": "Input options for the attribute" + }, + { + "key": "order", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The order of the attribute against other attributes" + }, + { + "key": "required_to_create", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Whether the attribute is required or not for teammates." + }, + { + "key": "required_to_create_for_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Whether the attribute is required or not for contacts." + }, + { + "key": "visible_on_create", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + }, + "description": "Whether the attribute is visible or not to teammates." + }, + { + "key": "visible_to_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + }, + "description": "Whether the attribute is visible or not to contacts." + }, + { + "key": "default", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the attribute is built in or not." + }, + { + "key": "ticket_type_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the ticket type that the attribute belongs to." + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the ticket type attribute is archived or not." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The date and time the ticket type attribute was created." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The date and time the ticket type attribute was last updated." + } + ] + } + } + }, + "description": "Ticket type attribute, used to define each data field to be captured in a ticket." + }, + "ticket_type_attribute_list": { + "name": "Ticket Type Attributes", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `ticket_type_attributes.list`." + }, + { + "key": "ticket_type_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type_attribute" + } + } + } + }, + "description": "A list of ticket type attributes associated with a given ticket type." + } + ] + }, + "description": "A list of attributes associated with a given ticket type." + }, + "ticket_type_list": { + "name": "Ticket Types", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "String representing the object's type. Always has the value `ticket_type.list`." + }, + { + "key": "ticket_types", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "ticket_type" + } + } + } + }, + "description": "A list of ticket_types associated with a given workspace." + } + ] + }, + "description": "A list of ticket types associated with a given workspace." + }, + "translation": { + "name": "Translation", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The localised name of the subscription type." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The localised description of the subscription type." + }, + { + "key": "locale", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The two character identifier for the language of the translation object." + } + ] + }, + "description": "A translation object contains the localised details of a subscription type." + }, + "untag_company_request": { + "name": "Untag Company Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag which will be untagged from the company" + }, + { + "key": "companies", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the company." + }, + { + "key": "company_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The company id you have defined for the company." + }, + { + "key": "untag", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Always set to true" + } + ] + } + } + }, + "description": "The id or company_id of the company can be passed as input parameters." + } + ] + }, + "description": "You can tag a single company or a list of companies." + }, + "update_article_request": { + "name": "Update Article Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "title", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The title of the article.For multilingual articles, this will be the title of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the article. For multilingual articles, this will be the description of the default language's content." + }, + { + "key": "body", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The content of the article. For multilingual articles, this will be the body of the default language's content." + }, + { + "key": "author_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "published" + }, + { + "value": "draft" + } + ] + }, + "description": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content." + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the article's parent collection or section. An article without this field stands alone." + }, + { + "key": "parent_type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The type of parent, which can either be a `collection` or `section`." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "article_translated_content" + } + } + } + ] + } + } + }, + "description": "You can Update an Article" + }, + "update_collection_request": { + "name": "Update Collection Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the collection. For multilingual collections, this will be the description of the default language's content." + }, + { + "key": "translated_content", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "group_translated_content" + } + } + } + } + }, + { + "key": "parent_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The id of the parent collection. If `null` then it will be updated as the first level collection." + } + ] + }, + "description": "You can update a collection" + }, + "update_contact_request": { + "name": "Update Contact Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "role", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The role of the contact." + }, + { + "key": "external_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A unique identifier for the contact which is given to Intercom" + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The contacts email" + }, + { + "key": "phone", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The contacts phone" + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The contacts name" + }, + { + "key": "avatar", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "An image URL containing the avatar of a contact" + }, + { + "key": "signed_up_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time specified for when a contact signed up" + }, + { + "key": "last_seen_at", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)" + }, + { + "key": "owner_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + }, + "description": "The id of an admin that has been assigned account ownership of the contact" + }, + { + "key": "unsubscribed_from_emails", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Whether the contact is unsubscribed from emails" + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [] + } + } + }, + "description": "The custom attributes which are set for the contact" + } + ] + }, + "description": "You can update a contact" + }, + "update_conversation_request": { + "name": "Update Conversation Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "read", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Mark a conversation as read within Intercom." + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "custom_attributes" + } + } + } + ] + }, + "description": "Payload of the request to update a conversation" + }, + "update_data_attribute_request": { + "name": "Update Data Attribute Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the attribute is to be archived or not." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The readable description you see in the UI for the attribute." + }, + { + "key": "options", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "To create list attributes. Provide a set of hashes with `value` as the key of the options you want to make. `data_type` must be `string`." + }, + { + "key": "messenger_writable", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Can this attribute be updated by the Messenger" + } + ] + }, + "description": "" + }, + "update_ticket_request": { + "name": "Update Ticket Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "ticket_attributes", + "valueShape": { + "type": "object", + "extends": [], + "properties": [] + }, + "description": "The attributes set on the ticket." + }, + { + "key": "state", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "in_progress" + }, + { + "value": "waiting_on_customer" + }, + { + "value": "resolved" + } + ] + }, + "description": "The state of the ticket." + }, + { + "key": "open", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it." + }, + { + "key": "is_shared", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Specify whether the ticket is visible to users." + }, + { + "key": "snoozed_until", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time you want the ticket to reopen." + }, + { + "key": "assignment", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "admin_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the admin performing the action." + }, + { + "key": "assignee_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it." + } + ] + } + } + ] + }, + "description": "You can update a Ticket" + }, + "update_ticket_type_attribute_request": { + "name": "Update Ticket Type Attribute Request Payload", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type attribute" + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the attribute presented to the teammate or contact" + }, + { + "key": "required_to_create", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox." + }, + { + "key": "required_to_create_for_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger." + }, + { + "key": "visible_on_create", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + }, + "description": "Whether the attribute is visible to teammates when creating a ticket in Inbox." + }, + { + "key": "visible_to_contacts", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": true + } + } + }, + "description": "Whether the attribute is visible to contacts when creating a ticket in Messenger." + }, + { + "key": "multiline", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the attribute allows multiple lines of text (only applicable to string attributes)" + }, + { + "key": "list_items", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "A comma delimited list of items for the attribute value (only applicable to list attributes)" + }, + { + "key": "allow_multiple_values", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)" + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)" + } + ] + }, + "description": "You can update a Ticket Type Attribute" + }, + "update_ticket_type_request": { + "name": "Update Ticket Type Request Payload", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the ticket type." + }, + { + "key": "description", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The description of the ticket type." + }, + { + "key": "category", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "Customer" + }, + { + "value": "Back-office" + }, + { + "value": "Tracker" + } + ] + }, + "description": "Category of the Ticket Type." + }, + { + "key": "icon", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "🎟️" + } + } + }, + "description": "The icon of the ticket type." + }, + { + "key": "archived", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "The archived status of the ticket type." + }, + { + "key": "is_internal", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + }, + "description": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute." + } + ] + } + } + }, + "description": "The request payload for updating a ticket type.\nYou can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + }, + "visitor": { + "name": "Visitor", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "visitor" + } + } + }, + "description": "Value is 'visitor'" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The Intercom defined id representing the Visitor." + }, + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Automatically generated identifier for the Visitor." + }, + { + "key": "anonymous", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this visitor is anonymous." + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "email" + } + } + }, + "description": "The email of the visitor." + }, + { + "key": "phone", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The phone number of the visitor." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The name of the visitor." + }, + { + "key": "pseudonym", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The pseudonym of the visitor." + }, + { + "key": "avatar", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "avatar" + } + } + }, + "description": "" + }, + { + "key": "image_url", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "format": "uri" + } + } + } + } + }, + "description": "This object represents the avatar associated with the visitor." + } + ] + } + }, + { + "key": "app_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the app the visitor is associated with." + }, + { + "key": "companies", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "company.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "companies", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "company" + } + } + } + } + } + ] + } + }, + { + "key": "location_data", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "default": "location_data" + } + } + }, + "description": "" + }, + { + "key": "city_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The city name of the visitor." + }, + { + "key": "continent_code", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The continent code of the visitor." + }, + { + "key": "country_code", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The country code of the visitor." + }, + { + "key": "country_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The country name of the visitor." + }, + { + "key": "postal_code", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The postal code of the visitor." + }, + { + "key": "region_name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The region name of the visitor." + }, + { + "key": "timezone", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The timezone of the visitor." + } + ] + } + }, + { + "key": "las_request_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the Lead last recorded making a request." + }, + { + "key": "created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the Visitor was added to Intercom." + }, + { + "key": "remote_created_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the Visitor was added to Intercom." + }, + { + "key": "signed_up_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The time the Visitor signed up for your product." + }, + { + "key": "updated_at", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The last time the Visitor was updated." + }, + { + "key": "session_count", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + }, + "description": "The number of sessions the Visitor has had." + }, + { + "key": "social_profiles", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "social_profile.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "social_profiles", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + { + "key": "owner_id", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The id of the admin that owns the Visitor." + }, + { + "key": "unsubscribed_from_emails", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Whether the Visitor is unsubscribed from emails." + }, + { + "key": "marked_email_as_spam", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this visitor has marked an email as spam." + }, + { + "key": "has_hard_bounced", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + }, + "description": "Identifies if this visitor has had a hard bounce." + }, + { + "key": "tags", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "tag.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "tags", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "tag" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The id of the tag." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The name of the tag." + } + ] + } + } + } + } + ] + } + }, + { + "key": "segments", + "valueShape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "segment.list" + } + ] + }, + "description": "The type of the object" + }, + { + "key": "segments", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + { + "key": "custom_attributes", + "valueShape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The custom attributes you have set on the Visitor." + }, + { + "key": "referrer", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The referer of the visitor." + }, + { + "key": "utm_campaign", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The utm_campaign of the visitor." + }, + { + "key": "utm_content", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The utm_content of the visitor." + }, + { + "key": "utm_medium", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The utm_medium of the visitor." + }, + { + "key": "utm_source", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The utm_source of the visitor." + }, + { + "key": "utm_term", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + }, + "description": "The utm_term of the visitor." + }, + { + "key": "do_not_track", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + }, + "description": "Identifies if this visitor has do not track enabled." + } + ] + } + } + }, + "description": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete." + }, + "visitor_deleted_object": { + "name": "Visitor Deleted Object", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The unique identifier for the visitor which is given by Intercom." + }, + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "visitor" + } + ] + }, + "description": "The type of object which was deleted" + }, + { + "key": "user_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Automatically generated identifier for the Visitor." + } + ] + }, + "description": "Response returned when an object is deleted" + } + }, + "subpackages": { + "admins": { + "id": "admins", + "name": "Admins", + "displayName": "Admins" + }, + "articles": { + "id": "articles", + "name": "Articles", + "displayName": "Articles" + }, + "helpCenter": { + "id": "helpCenter", + "name": "Help Center", + "displayName": "Help Center" + }, + "companies": { + "id": "companies", + "name": "Companies", + "displayName": "Companies" + }, + "contacts": { + "id": "contacts", + "name": "Contacts", + "displayName": "Contacts" + }, + "notes": { + "id": "notes", + "name": "Notes", + "displayName": "Notes" + }, + "segments": { + "id": "segments", + "name": "Segments", + "displayName": "Segments" + }, + "subscriptionTypes": { + "id": "subscriptionTypes", + "name": "Subscription Types", + "displayName": "Subscription Types" + }, + "tags": { + "id": "tags", + "name": "Tags", + "displayName": "Tags" + }, + "conversations": { + "id": "conversations", + "name": "Conversations", + "displayName": "Conversations" + }, + "dataAttributes": { + "id": "dataAttributes", + "name": "Data Attributes", + "displayName": "Data Attributes" + }, + "dataEvents": { + "id": "dataEvents", + "name": "Data Events", + "displayName": "Data Events" + }, + "dataExport": { + "id": "dataExport", + "name": "Data Export", + "displayName": "Data Export" + }, + "messages": { + "id": "messages", + "name": "Messages", + "displayName": "Messages" + }, + "news": { + "id": "news", + "name": "News", + "displayName": "News" + }, + "switch": { + "id": "switch", + "name": "Switch", + "displayName": "Switch" + }, + "teams": { + "id": "teams", + "name": "Teams", + "displayName": "Teams" + }, + "ticketTypeAttributes": { + "id": "ticketTypeAttributes", + "name": "Ticket Type Attributes", + "displayName": "Ticket Type Attributes" + }, + "ticketTypes": { + "id": "ticketTypes", + "name": "Ticket Types", + "displayName": "Ticket Types" + }, + "tickets": { + "id": "tickets", + "name": "Tickets", + "displayName": "Tickets" + }, + "visitors": { + "id": "visitors", + "name": "Visitors", + "displayName": "Visitors" + } + }, + "auths": { + "bearerAuth": { + "type": "bearerAuth" + } + } +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/query-params.json b/packages/parsers/src/openapi/__test__/__snapshots__/query-params.json new file mode 100644 index 0000000000..66dc9051da --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/query-params.json @@ -0,0 +1 @@ +undefined \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/readonly.json b/packages/parsers/src/openapi/__test__/__snapshots__/readonly.json new file mode 100644 index 0000000000..9e019daee9 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/readonly.json @@ -0,0 +1,373 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.users": { + "id": "endpoint_.users", + "displayName": "Create a user", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "users" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "UserCreate" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "User" + } + }, + "description": "User created successfully" + } + ], + "errors": [], + "examples": [ + { + "path": "/users", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "id": "string", + "name": "string", + "email": "string", + "createdAt": "string", + "settings": { + "theme": "string", + "notifications": false, + "lastModified": "string" + }, + "stats": { + "totalLogins": 0, + "lastLoginTime": "string", + "accountStatus": "active" + } + } + } + } + ] + }, + "endpoint_.userId": { + "id": "endpoint_.userId", + "displayName": "Get a user", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "users" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "userId" + } + ], + "environments": [], + "pathParameters": [ + { + "key": "userId", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "User" + } + }, + "description": "User retrieved successfully" + } + ], + "errors": [], + "examples": [ + { + "path": "/users/{userId}", + "responseStatusCode": 200, + "pathParameters": { + "userId": "string" + }, + "responseBody": { + "type": "json", + "value": { + "id": "string", + "name": "string", + "email": "string", + "createdAt": "string", + "settings": { + "theme": "string", + "notifications": false, + "lastModified": "string" + }, + "stats": { + "totalLogins": 0, + "lastLoginTime": "string", + "accountStatus": "active" + } + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "UserCreate": { + "name": "UserCreate", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "settings", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "UserSettings" + } + } + } + ] + } + }, + "User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "createdAt", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "settings", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "UserSettings" + } + } + }, + { + "key": "stats", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "UserStats" + } + } + } + ] + } + }, + "UserSettings": { + "name": "UserSettings", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "theme", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "notifications", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + }, + { + "key": "lastModified", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + } + ] + } + }, + "UserStats": { + "name": "UserStats", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "totalLogins", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "lastLoginTime", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "datetime" + } + } + } + }, + { + "key": "accountStatus", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "active" + }, + { + "value": "suspended" + }, + { + "value": "deleted" + } + ] + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/request-response-description.json b/packages/parsers/src/openapi/__test__/__snapshots__/request-response-description.json new file mode 100644 index 0000000000..8d2d1e2617 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/request-response-description.json @@ -0,0 +1,64 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.example": { + "id": "endpoint_.example", + "displayName": "Get Example", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "example" + } + ], + "environments": [], + "responses": [], + "errors": [], + "examples": [] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "Schema1": { + "name": "Schema1", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + }, + "description": "Schema 1 description" + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/rules.json b/packages/parsers/src/openapi/__test__/__snapshots__/rules.json new file mode 100644 index 0000000000..cf332ad85c --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/rules.json @@ -0,0 +1,120 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.example": { + "id": "endpoint_.example", + "displayName": "Default and validation rules", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "example" + } + ], + "environments": [], + "responses": [], + "errors": [], + "examples": [] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "String": { + "name": "String", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "regex": "^[a-zA-Z0-9]*$", + "minLength": 3, + "maxLength": 10, + "default": "fern" + } + } + } + }, + "Schema": { + "name": "Schema", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 10, + "maximum": 100, + "default": 50 + } + } + }, + "description": "The unique ID of the type." + }, + { + "key": "age", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": -2147483649, + "maximum": 2147483648, + "default": 50 + } + } + }, + "description": "The age of the type." + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string", + "regex": "^[a-zA-Z0-9]*$", + "minLength": 3, + "maxLength": 10, + "default": "type" + } + } + }, + "description": "The unique name of the type." + }, + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double", + "minimum": 1.1, + "maximum": 2.2, + "default": 1.1 + } + } + }, + "description": "The value of the type." + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/streaming.json b/packages/parsers/src/openapi/__test__/__snapshots__/streaming.json new file mode 100644 index 0000000000..200bab05d0 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/streaming.json @@ -0,0 +1,275 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.user": { + "id": "endpoint_.user", + "operationId": "user", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "v1" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "users" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "User" + } + }, + "description": "" + } + ], + "errors": [], + "examples": [ + { + "path": "/v1/users", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "id": "string" + } + } + } + ] + }, + "endpoint_.user_v2": { + "id": "endpoint_.user_v2", + "operationId": "user_v2", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "v2" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "users" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "User" + } + }, + "description": "" + } + ], + "errors": [], + "examples": [ + { + "path": "/v2/users", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "id": "string" + } + } + } + ] + }, + "endpoint_.user_v3": { + "id": "endpoint_.user_v3", + "operationId": "user_v3", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "v3" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "users" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "" + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "User" + } + }, + "description": "" + } + ], + "errors": [], + "examples": [ + { + "path": "/v3/users", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "id": "string" + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + } + ] + } + }, + "StreamUser": { + "name": "StreamUser", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/uint.json b/packages/parsers/src/openapi/__test__/__snapshots__/uint.json new file mode 100644 index 0000000000..77f2cc80d5 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/uint.json @@ -0,0 +1,134 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.Get": { + "id": "endpoint_.Get", + "operationId": "Get", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "get" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Request" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "Response" + } + }, + "description": "A simple API response." + } + ], + "errors": [], + "examples": [ + { + "path": "/get", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": { + "id": 0, + "value": 0 + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "Request": { + "name": "Request", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + }, + "description": "A generic request type used throughout the API.\n" + }, + "Response": { + "name": "Response", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + { + "key": "value", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + }, + "description": "A generic response type used throughout the API.\n" + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/union-extension.json b/packages/parsers/src/openapi/__test__/__snapshots__/union-extension.json new file mode 100644 index 0000000000..2e27cfbd16 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/union-extension.json @@ -0,0 +1,126 @@ +{ + "id": "test-uuid-replacement", + "endpoints": {}, + "websockets": {}, + "webhooks": {}, + "types": { + "PartyAccount": { + "name": "PartyAccount", + "shape": { + "type": "undiscriminatedUnion", + "variants": [] + }, + "description": "PartyAccount with excluded currency in response" + }, + "IbanField": { + "name": "IbanField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "iban", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + "OtherField": { + "name": "OtherField", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "other", + "valueShape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "id", + "id": "Other" + } + } + } + } + } + ] + } + }, + "Other": { + "name": "Other", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "identification", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "schemeNameCone", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "CounterPartyAccount": { + "name": "CounterPartyAccount", + "shape": { + "type": "object", + "extends": [ + "PartyAccount" + ], + "properties": [ + { + "key": "currency", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/unions-v1.json b/packages/parsers/src/openapi/__test__/__snapshots__/unions-v1.json new file mode 100644 index 0000000000..4a6a243cfb --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/unions-v1.json @@ -0,0 +1,86 @@ +{ + "id": "test-uuid-replacement", + "endpoints": {}, + "websockets": {}, + "webhooks": {}, + "types": { + "Triangle": { + "name": "Triangle", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "triangle" + } + ] + } + }, + { + "key": "base", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + }, + { + "key": "height", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + } + }, + "Square": { + "name": "Square", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "type", + "valueShape": { + "type": "enum", + "values": [ + { + "value": "square" + } + ] + } + }, + { + "key": "sideLength", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/uploadcare.json b/packages/parsers/src/openapi/__test__/__snapshots__/uploadcare.json index cb60bef904..78694c9bce 100644 --- a/packages/parsers/src/openapi/__test__/__snapshots__/uploadcare.json +++ b/packages/parsers/src/openapi/__test__/__snapshots__/uploadcare.json @@ -15628,7 +15628,8 @@ "type": "alias", "value": { "type": "id", - "id": "webhook_is_active" + "id": "webhook_is_active", + "default": true } } }, @@ -15728,7 +15729,8 @@ "type": "alias", "value": { "type": "id", - "id": "webhook_is_active" + "id": "webhook_is_active", + "default": true } } }, @@ -15958,7 +15960,8 @@ "type": "alias", "value": { "type": "id", - "id": "webhook_is_active" + "id": "webhook_is_active", + "default": true } } }, diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/use-title-false.json b/packages/parsers/src/openapi/__test__/__snapshots__/use-title-false.json new file mode 100644 index 0000000000..79ea25f023 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/use-title-false.json @@ -0,0 +1,18 @@ +{ + "id": "test-uuid-replacement", + "endpoints": {}, + "websockets": {}, + "webhooks": {}, + "types": { + "UnionJob": { + "name": "UnionJob", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/use-title-true.json b/packages/parsers/src/openapi/__test__/__snapshots__/use-title-true.json new file mode 100644 index 0000000000..79ea25f023 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/use-title-true.json @@ -0,0 +1,18 @@ +{ + "id": "test-uuid-replacement", + "endpoints": {}, + "websockets": {}, + "webhooks": {}, + "types": { + "UnionJob": { + "name": "UnionJob", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/webhooks.json b/packages/parsers/src/openapi/__test__/__snapshots__/webhooks.json new file mode 100644 index 0000000000..bba3a4597e --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/webhooks.json @@ -0,0 +1,61 @@ +{ + "id": "test-uuid-replacement", + "endpoints": {}, + "websockets": {}, + "webhooks": {}, + "types": { + "Pet": { + "name": "Pet", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "long" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "tag", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-audiences.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-audiences.json new file mode 100644 index 0000000000..4e8705f55a --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-audiences.json @@ -0,0 +1,101 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.users": { + "id": "endpoint_.users", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "v1" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "users" + } + ], + "defaultEnvironment": "production", + "environments": [ + { + "id": "production", + "baseUrl": "https://api.com" + }, + { + "id": "sandbox", + "baseUrl": "https://private.api.com" + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "public_property", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "private_property", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + } + ], + "examples": [] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "BaseUser": { + "name": "BaseUser", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-auth-variables.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-auth-variables.json new file mode 100644 index 0000000000..66dc9051da --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-auth-variables.json @@ -0,0 +1 @@ +undefined \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-base-path.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-base-path.json new file mode 100644 index 0000000000..66dc9051da --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-base-path.json @@ -0,0 +1 @@ +undefined \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-encoding.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-encoding.json new file mode 100644 index 0000000000..448ebc7448 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-encoding.json @@ -0,0 +1,53 @@ +{ + "id": "test-uuid-replacement", + "endpoints": {}, + "websockets": {}, + "webhooks": {}, + "types": { + "Metadata": { + "name": "Metadata", + "shape": { + "type": "alias", + "value": { + "type": "map", + "keyShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "MetadataValue" + } + } + } + } + }, + "MetadataValue": { + "name": "MetadataValue", + "shape": { + "type": "alias", + "value": { + "type": "nullable", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "double" + } + } + } + } + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-enum.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-enum.json new file mode 100644 index 0000000000..ef259110af --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-enum.json @@ -0,0 +1,22 @@ +{ + "id": "test-uuid-replacement", + "endpoints": {}, + "websockets": {}, + "webhooks": {}, + "types": { + "SpeechModel": { + "name": "SpeechModel", + "shape": { + "type": "enum", + "values": [ + { + "value": "nano" + } + ] + }, + "description": "The speech model to use for the transcription." + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-global-headers.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-global-headers.json new file mode 100644 index 0000000000..a7304c8a15 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-global-headers.json @@ -0,0 +1,233 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_user.get": { + "id": "endpoint_user.get", + "namespace": [ + "user" + ], + "operationId": "get", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "user" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "userId" + } + ], + "environments": [], + "pathParameters": [ + { + "key": "userId", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "requestHeaders": [ + { + "key": "my-api-key", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "another_header", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "x-api-key", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "my-api-version", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "stream", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Success!" + } + ], + "errors": [], + "examples": [ + { + "path": "/user/{userId}", + "responseStatusCode": 200, + "pathParameters": { + "userId": "string" + }, + "headers": { + "my-api-key": "string", + "another_header": "string", + "x-api-key": "string", + "my-api-version": "string" + }, + "responseBody": { + "type": "json", + "value": "string" + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + }, + { + "key": "streamed", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "StreamUser": { + "name": "StreamUser", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + }, + { + "key": "streamed", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + } + }, + "subpackages": { + "user": { + "id": "user", + "name": "user", + "displayName": "user" + } + }, + "auths": {}, + "globalHeaders": [] +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-idempotency-headers.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-idempotency-headers.json new file mode 100644 index 0000000000..cfabb0b5dc --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-idempotency-headers.json @@ -0,0 +1,74 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.send": { + "id": "endpoint_.send", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "send" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "send", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Success!" + } + ], + "errors": [], + "examples": [ + { + "path": "/send", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": "string" + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": {}, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-ignore.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-ignore.json new file mode 100644 index 0000000000..7e3bf99a2c --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-ignore.json @@ -0,0 +1,258 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.list": { + "id": "endpoint_.list", + "description": "", + "displayName": "List", + "operationId": "list", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "list" + } + ], + "environments": [], + "queryParameters": [ + { + "key": "pageNumber", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + } + }, + { + "key": "limit", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + } + }, + { + "key": "ignoredParam1", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + }, + { + "key": "ignoredParam2", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "UsersResponse" + } + }, + "description": "Success" + } + ], + "errors": [], + "examples": [ + { + "path": "/list", + "responseStatusCode": 200, + "queryParameters": { + "pageNumber": 0, + "limit": 0, + "ignoredParam1": "string", + "ignoredParam2": "string" + }, + "responseBody": { + "type": "json", + "value": { + "meta": { + "hasMore": false + }, + "users": [ + { + "id": "string", + "name": "string", + "email": "string", + "age": 0 + } + ] + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "Meta": { + "name": "Meta", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "hasMore", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "UsersResponse": { + "name": "UsersResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "meta", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "Meta" + } + } + }, + { + "key": "users", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "User" + } + } + } + } + } + ] + } + }, + "User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "age", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-pagination.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-pagination.json new file mode 100644 index 0000000000..19b3584154 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-pagination.json @@ -0,0 +1,220 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_.list": { + "id": "endpoint_.list", + "description": "", + "displayName": "List", + "operationId": "list", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "list-with-step" + } + ], + "environments": [], + "queryParameters": [ + { + "key": "pageNumber", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + } + }, + { + "key": "limit", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "UsersResponse" + } + }, + "description": "Success" + } + ], + "errors": [], + "examples": [ + { + "path": "/list-with-step", + "responseStatusCode": 200, + "queryParameters": { + "pageNumber": 0, + "limit": 0 + }, + "responseBody": { + "type": "json", + "value": { + "meta": { + "hasMore": false + }, + "users": [ + { + "id": "string", + "name": "string", + "email": "string", + "age": 0 + } + ] + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "Meta": { + "name": "Meta", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "hasMore", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "UsersResponse": { + "name": "UsersResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "meta", + "valueShape": { + "type": "alias", + "value": { + "type": "id", + "id": "Meta" + } + } + }, + { + "key": "users", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "User" + } + } + } + } + } + ] + } + }, + "User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + }, + { + "key": "name", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "email", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + { + "key": "age", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-parameter-name.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-parameter-name.json new file mode 100644 index 0000000000..66dc9051da --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-parameter-name.json @@ -0,0 +1 @@ +undefined \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-property-name.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-property-name.json new file mode 100644 index 0000000000..9ec8e14488 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-property-name.json @@ -0,0 +1,31 @@ +{ + "id": "test-uuid-replacement", + "endpoints": {}, + "websockets": {}, + "webhooks": {}, + "types": { + "BaseUser": { + "name": "BaseUser", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-resolutions.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-resolutions.json new file mode 100644 index 0000000000..66dc9051da --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-resolutions.json @@ -0,0 +1 @@ +undefined \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-sdk-group-name-with-streaming.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-sdk-group-name-with-streaming.json new file mode 100644 index 0000000000..05bae1140a --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-sdk-group-name-with-streaming.json @@ -0,0 +1,176 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_user.get": { + "id": "endpoint_user.get", + "namespace": [ + "user" + ], + "operationId": "get", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "user" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "userId" + } + ], + "environments": [], + "pathParameters": [ + { + "key": "userId", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "stream", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Success!" + } + ], + "errors": [], + "examples": [ + { + "path": "/user/{userId}", + "responseStatusCode": 200, + "pathParameters": { + "userId": "string" + }, + "responseBody": { + "type": "json", + "value": "string" + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + }, + { + "key": "streamed", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "StreamUser": { + "name": "StreamUser", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + }, + { + "key": "streamed", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + } + }, + "subpackages": { + "user": { + "id": "user", + "name": "user", + "displayName": "user" + } + }, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-sdk-group-name.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-sdk-group-name.json new file mode 100644 index 0000000000..5f0f6f1c30 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-sdk-group-name.json @@ -0,0 +1,93 @@ +{ + "id": "test-uuid-replacement", + "endpoints": {}, + "websockets": {}, + "webhooks": {}, + "types": { + "UserId": { + "name": "UserId", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "PersonId": { + "name": "PersonId", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + }, + "User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + }, + { + "key": "associatedPersons", + "valueShape": { + "type": "alias", + "value": { + "type": "list", + "itemShape": { + "type": "alias", + "value": { + "type": "id", + "id": "Person" + } + } + } + } + } + ] + }, + "description": "This user object should be in user.yml" + }, + "Person": { + "name": "Person", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + } + ] + } + } + }, + "subpackages": {}, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-audiences.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-audiences.json new file mode 100644 index 0000000000..dacb200459 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-audiences.json @@ -0,0 +1,176 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_user.get": { + "id": "endpoint_user.get", + "namespace": [ + "user" + ], + "operationId": "get", + "method": "GET", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "user" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "pathParameter", + "value": "userId" + } + ], + "environments": [], + "pathParameters": [ + { + "key": "userId", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "stream", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Success!" + } + ], + "errors": [], + "examples": [ + { + "path": "/user/{userId}", + "responseStatusCode": 200, + "pathParameters": { + "userId": "string" + }, + "responseBody": { + "type": "json", + "value": "string" + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "User": { + "name": "User", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + }, + { + "key": "streamed", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + }, + "StreamUser": { + "name": "StreamUser", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "uuid" + } + } + } + }, + { + "key": "streamed", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + ] + } + } + }, + "subpackages": { + "user": { + "id": "user", + "name": "user", + "displayName": "user" + } + }, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-reference.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-reference.json new file mode 100644 index 0000000000..17da6a2125 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-reference.json @@ -0,0 +1,162 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_chatCompletions.create": { + "id": "endpoint_chatCompletions.create", + "namespace": [ + "chatCompletions" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "completions" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "chat" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "CreateCompletionRequest" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Success!" + } + ], + "errors": [], + "examples": [ + { + "path": "/completions/chat", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": "string" + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "CreateCompletionRequest": { + "name": "CreateCompletionRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "stream", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + } + }, + { + "key": "prompt", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "Completion": { + "name": "Completion", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "CompletionChunk": { + "name": "CompletionChunk", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + } + }, + "subpackages": { + "chatCompletions": { + "id": "chatCompletions", + "name": "chatCompletions", + "displayName": "chatCompletions" + } + }, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-sse.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-sse.json new file mode 100644 index 0000000000..17da6a2125 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-sse.json @@ -0,0 +1,162 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_chatCompletions.create": { + "id": "endpoint_chatCompletions.create", + "namespace": [ + "chatCompletions" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "completions" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "chat" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "CreateCompletionRequest" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Success!" + } + ], + "errors": [], + "examples": [ + { + "path": "/completions/chat", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": "string" + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "CreateCompletionRequest": { + "name": "CreateCompletionRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "stream", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + } + }, + { + "key": "prompt", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "Completion": { + "name": "Completion", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "CompletionChunk": { + "name": "CompletionChunk", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + } + }, + "subpackages": { + "chatCompletions": { + "id": "chatCompletions", + "name": "chatCompletions", + "displayName": "chatCompletions" + } + }, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-stream-condition.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-stream-condition.json new file mode 100644 index 0000000000..07e823f901 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-streaming-with-stream-condition.json @@ -0,0 +1,307 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_chats.chat": { + "id": "endpoint_chats.chat", + "description": "Create a chat while specifying the default retrieval parameters used by the prompt.", + "namespace": [ + "Chats" + ], + "displayName": "Start a chat", + "operationId": "createChat", + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "v2" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "chats" + } + ], + "defaultEnvironment": "https://api.streamingtest.io", + "environments": [ + { + "id": "https://api.streamingtest.io", + "baseUrl": "https://api.streamingtest.io" + } + ], + "requestHeaders": [ + { + "key": "Request-Timeout", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1 + } + } + } + } + }, + "description": "The API will make a best effort to complete the request in the specified seconds or time out." + }, + { + "key": "Request-Timeout-Millis", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "integer", + "minimum": 1 + } + } + } + } + }, + "description": "The API will make a best effort to complete the request in the specified milliseconds or time out." + } + ], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ChatRequest" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ChatFullResponse" + } + }, + "description": "A response to a chat request." + }, + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "ChatStreamedResponse" + } + }, + "description": "A response to a chat request." + } + ], + "errors": [], + "examples": [ + { + "path": "/v2/chats", + "responseStatusCode": 200, + "headers": { + "Request-Timeout": 0, + "Request-Timeout-Millis": 0 + }, + "responseBody": { + "type": "json", + "value": { + "chat_id": "string", + "turn_id": "string", + "answer": "string" + } + } + }, + { + "path": "/v2/chats", + "responseStatusCode": 200, + "headers": { + "Request-Timeout": 0, + "Request-Timeout-Millis": 0 + }, + "responseBody": { + "type": "json", + "value": { + "chunk": "Hello, how can I help you today?" + } + } + }, + { + "path": "/v2/chats", + "responseStatusCode": 200, + "headers": { + "Request-Timeout": 0, + "Request-Timeout-Millis": 0 + }, + "responseBody": { + "type": "json", + "value": { + "chat_id": "string", + "turn_id": "string", + "answer": "string" + } + } + }, + { + "path": "/v2/chats", + "responseStatusCode": 200, + "headers": { + "Request-Timeout": 0, + "Request-Timeout-Millis": 0 + }, + "responseBody": { + "type": "json", + "value": { + "chunk": "Hello, how can I help you today?" + } + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "ChatRequest": { + "name": "ChatRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "query", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The chat message or question." + }, + { + "key": "stream_response", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean", + "default": false + } + } + } + } + }, + "description": "Indicates whether the response should be streamed or not." + } + ] + } + }, + "ChatFullResponse": { + "name": "ChatFullResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "chat_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If the chat response was stored, the ID of the chat." + }, + { + "key": "turn_id", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "If the chat response was stored, the ID of the turn." + }, + { + "key": "answer", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The message from the chat model for the chat message." + } + ] + }, + "description": "Full response to a chat question when the result is not streamed." + }, + "ChatStreamedResponse": { + "name": "ChatStreamedResponse", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "chunk", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "The chunk of the response." + } + ] + }, + "description": "An individual event when the response is streamed." + } + }, + "subpackages": { + "chats": { + "id": "chats", + "name": "Chats", + "displayName": "Chats" + } + }, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-token-variable-name.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-token-variable-name.json new file mode 100644 index 0000000000..17da6a2125 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-token-variable-name.json @@ -0,0 +1,162 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_chatCompletions.create": { + "id": "endpoint_chatCompletions.create", + "namespace": [ + "chatCompletions" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "completions" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "chat" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "CreateCompletionRequest" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Success!" + } + ], + "errors": [], + "examples": [ + { + "path": "/completions/chat", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": "string" + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "CreateCompletionRequest": { + "name": "CreateCompletionRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "stream", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + } + }, + { + "key": "prompt", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "Completion": { + "name": "Completion", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "CompletionChunk": { + "name": "CompletionChunk", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + } + }, + "subpackages": { + "chatCompletions": { + "id": "chatCompletions", + "name": "chatCompletions", + "displayName": "chatCompletions" + } + }, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-version.json b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-version.json new file mode 100644 index 0000000000..17da6a2125 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/__snapshots__/x-fern-version.json @@ -0,0 +1,162 @@ +{ + "id": "test-uuid-replacement", + "endpoints": { + "endpoint_chatCompletions.create": { + "id": "endpoint_chatCompletions.create", + "namespace": [ + "chatCompletions" + ], + "method": "POST", + "path": [ + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "completions" + }, + { + "type": "literal", + "value": "/" + }, + { + "type": "literal", + "value": "chat" + } + ], + "environments": [], + "requests": [ + { + "contentType": "application/json", + "body": { + "type": "alias", + "value": { + "type": "id", + "id": "CreateCompletionRequest" + } + } + } + ], + "responses": [ + { + "statusCode": 200, + "body": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + "description": "Success!" + } + ], + "errors": [], + "examples": [ + { + "path": "/completions/chat", + "responseStatusCode": 200, + "responseBody": { + "type": "json", + "value": "string" + } + } + ] + } + }, + "websockets": {}, + "webhooks": {}, + "types": { + "CreateCompletionRequest": { + "name": "CreateCompletionRequest", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "stream", + "valueShape": { + "type": "alias", + "value": { + "type": "optional", + "shape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "boolean" + } + } + } + } + } + }, + { + "key": "prompt", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "Completion": { + "name": "Completion", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + }, + "CompletionChunk": { + "name": "CompletionChunk", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "text", + "valueShape": { + "type": "alias", + "value": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + } + ] + } + } + }, + "subpackages": { + "chatCompletions": { + "id": "chatCompletions", + "name": "chatCompletions", + "displayName": "chatCompletions" + } + }, + "auths": {} +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/anyOf/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/anyOf/openapi.yml new file mode 100644 index 0000000000..c0c7290296 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/anyOf/openapi.yml @@ -0,0 +1,49 @@ +openapi: 3.0.3 +info: + title: Test spec for `description` settings defined in anyOf. + version: 1.0.0 + +paths: + /get: + get: + operationId: Get + requestBody: + required: true + description: A simple API request. + content: + application/json: + schema: + $ref: "#/components/schemas/Request" + responses: + '200': + description: A simple API response. + content: + application/json: + schema: + $ref: "#/components/schemas/Response" + +components: + schemas: + Request: + description: | + A generic request type used throughout the API. + properties: + id: + anyOf: + - type: string + - type: 'null' + description: | + An optional string value. + title: ID + + Response: + description: | + A generic response type used throughout the API. + properties: + value: + anyOf: + - type: number + - type: 'null' + description: | + An optional numerical value. + title: Value \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/application-json/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/application-json/openapi.yml new file mode 100644 index 0000000000..086d1e415d --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/application-json/openapi.yml @@ -0,0 +1,31 @@ +openapi: 3.0.3 +info: + title: Test vnd.fern.user+json;version=1 and /application-json + version: 1.0.0 +paths: + /vnd.fern.user+json;version=1: + get: + responses: + "200": + description: "Success" + content: + vnd.fern.user+json;version=1: + schema: + $ref: '#/components/schemas/Data' + /application-json: + get: + responses: + "200": + description: "Success" + content: + application/json: + schema: + $ref: '#/components/schemas/Data' +components: + schemas: + Data: + properties: + foo: + type: string + bar: + type: string diff --git a/packages/parsers/src/openapi/__test__/fixtures/availability/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/availability/openapi.yml new file mode 100644 index 0000000000..3dcd59a981 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/availability/openapi.yml @@ -0,0 +1,178 @@ +openapi: 3.1.0 +info: + title: Deprecated params and fields + version: 1.0.0 +paths: + /collection/{id}/{active_id}/{deprecated_ref_id}/{x-fern-availability_path_param}: + get: + parameters: + - in: query + name: deprecated_lang + schema: + type: string + description: language code + deprecated: true + - in: query + name: active_lang + schema: + type: string + description: language code + - in: query + name: deprecated_ref_lang + schema: + $ref: '#/components/schemas/DeprecatedParam' + - in: query + name: x-fern-availability_query_param + schema: + type: string + description: active beta query param + x-fern-availability: 'beta' + - in: path + required: true + name: id + schema: + type: string + description: collection id + deprecated: true + - in: path + required: true + name: active_id + schema: + type: string + description: active header + - in: path + required: true + name: deprecated_ref_id + schema: + $ref: '#/components/schemas/DeprecatedParam' + - in: path + required: true + name: x-fern-availability_path_param + schema: + type: string + description: active beta header + x-fern-availability: 'beta' + - in: header + name: X-Deprecated-Header + schema: + type: string + description: deprecated header + deprecated: true + - in: header + name: X-Active-Header + schema: + type: string + description: active header + - in: header + name: X-Deprecated-Ref-Header + schema: + $ref: '#/components/schemas/DeprecatedParam' + - in: header + name: x-fern-availability_header + schema: + type: string + description: active beta header + x-fern-availability: 'beta' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/WholeDeprecatedSettings' + /success-ref: + post: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Settings' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NotDeprecatedSettings' + /success-inline-property-deprecation: + post: + requestBody: + content: + application/json: + schema: + type: object + properties: + deprecated_setting: + type: boolean + deprecated: true + new_setting: + type: boolean + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NotDeprecatedSettings' + /success-inline-object-deprecation: + post: + requestBody: + content: + application/json: + schema: + type: object + properties: + fine_setting: + type: boolean + deprecated: true + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NotDeprecatedSettings' + deprecated: true + /success-inline-beta-body: + post: + requestBody: + content: + application/json: + schema: + type: object + properties: + fine_setting: + type: boolean + x-fern-availability: 'beta' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NotDeprecatedSettings' + x-fern-availability: 'beta' +components: + schemas: + DeprecatedParam: + type: string + deprecated: true + Settings: + type: object + properties: + deprecated_setting: + type: boolean + deprecated: true + new_setting: + type: boolean + WholeDeprecatedSettings: + type: object + properties: + fine_setting: + type: boolean + deprecated: true + NotDeprecatedSettings: + type: object + properties: + not_deprecated_setting: + type: boolean diff --git a/packages/parsers/src/openapi/__test__/fixtures/content-type/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/content-type/openapi.yml new file mode 100644 index 0000000000..17857e62dd --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/content-type/openapi.yml @@ -0,0 +1,54 @@ +openapi: 3.1.0 +info: + title: Test content-type parsing. + version: 1.0.0 +paths: + /test: + post: + summary: Test upload + description: | + Test multipart request with different content types. + parameters: + - in: path + name: corpus_key + description: The unique key + required: true + schema: + type: string + requestBody: + description: | + Test request body + content: + multipart/form-data: + schema: + type: object + properties: + metadata: + description: Arbitrary object that will be attached as document metadata to the extracted document. + type: object + additionalProperties: true + chunking_strategy: + $ref: "#/components/schemas/ChunkingStrategy" + filename: + description: Optional multipart section to override the filename. + type: string + file: + description: Binary file contents. The file name of the file will be used as the document ID. + type: string + format: binary + required: + - file + encoding: + foo: + contentType: application/json + file: + contentType: application/octet-stream, application/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.oasis.opendocument.text, application/epub+zip, application/rtf, text/html, text/plain, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, text/markdown + bar: + contentType: text/plain + responses: + "201": + description: The sample response + content: + application/json: + schema: + type: string \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/default-content/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/default-content/openapi.yml new file mode 100644 index 0000000000..a04104d0ff --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/default-content/openapi.yml @@ -0,0 +1,32 @@ +--- +openapi: 3.0.3 +info: + title: Default Content Type + version: v1 +servers: +- url: https://ai.com +paths: + "/generateContent": + post: + tags: + - generativelanguage + operationId: GenerateContent + parameters: + - name: model + in: path + required: true + schema: + type: string + responses: + default: + description: Successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/GenerateContentResponse" +components: + schemas: + GenerateContentResponse: + properties: + bar: + type: string \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/defaults/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/defaults/openapi.yml new file mode 100644 index 0000000000..653ef3f316 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/defaults/openapi.yml @@ -0,0 +1,63 @@ +openapi: 3.0.0 +info: + title: API with Default Values + version: 1.0.0 +paths: + /test: + get: + parameters: + - name: boolParam1 + in: query + schema: + type: boolean + default: true + - name: boolParam2 + in: query + schema: + type: boolean + default: "true" + - name: boolParam3 + in: query + schema: + type: boolean + default: false + - name: boolParam4 + in: query + schema: + type: boolean + default: "false" + - name: stringParam + in: query + schema: + type: string + default: "defaultString" + - name: numberParam + in: query + schema: + type: number + default: 42 + - name: integerParam + in: query + schema: + type: integer + default: 100 + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object + properties: + boolField1: + type: boolean + default: true + boolField2: + type: boolean + default: "true" + stringField: + type: string + default: "defaultValue" + numberField: + type: number + default: 3.14 diff --git a/packages/parsers/src/openapi/__test__/fixtures/discriminated-union-value-title/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/discriminated-union-value-title/openapi.yml new file mode 100644 index 0000000000..958380f514 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/discriminated-union-value-title/openapi.yml @@ -0,0 +1,61 @@ +openapi: 3.0.3 +info: + title: Test spec for `description` settings defined in anyOf. + version: 1.0.0 + +paths: + /get: + get: + operationId: Get + requestBody: + required: true + description: A simple API request. + content: + application/json: + schema: + $ref: "#/components/schemas/Request" + responses: + '200': + description: A simple API response. + content: + application/json: + schema: + $ref: "#/components/schemas/Response" + +components: + schemas: + Request: + title: A simple request title + description: | + A generic request type used throughout the API. + properties: + id: + anyOf: + - type: string + - type: 'null' + description: | + An optional string value. + title: ID + + Response: + title: A simple response title + description: | + A generic response type used throughout the API. + properties: + value: + anyOf: + - type: number + - type: 'null' + description: | + An optional numerical value. + title: Value + + SampleUnion: + oneOf: + - $ref: "#/components/schemas/Request" + - $ref: "#/components/schemas/Response" + discriminator: + propertyName: type + mapping: + request: "#/components/schemas/Request" + response: "#/components/schemas/Response" diff --git a/packages/parsers/src/openapi/__test__/fixtures/enum-casing/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/enum-casing/openapi.yml new file mode 100644 index 0000000000..35ab162898 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/enum-casing/openapi.yml @@ -0,0 +1,39 @@ +openapi: 3.0.0 +info: + title: Example API + version: 1.0.0 +paths: + /example: + get: + summary: Get Example + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: "#/components/schemas/ExampleResponse" +components: + schemas: + ExampleResponse: + type: object + properties: + status: + type: string + enum: [success, failure] + message: + type: string + custom_fields: + type: object + additionalProperties: + type: string + GrantTypeEnum: + type: string + enum: + - urn:devrev:params:oauth:grant-type:token-issue + - urn:ietf:params:oauth:grant-type:token-exchange + x-fern-enum: + urn:devrev:params:oauth:grant-type:token-issue: + name: urn-devrev-params-oauth-grant-type-token-issue + urn:ietf:params:oauth:grant-type:token-exchange: + name: urn-ietf-params-oauth-grant-type-token-exchange diff --git a/packages/parsers/src/openapi/__test__/fixtures/example-depth/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/example-depth/openapi.yml new file mode 100644 index 0000000000..1983b7694e --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/example-depth/openapi.yml @@ -0,0 +1,34 @@ +openapi: 3.0.0 +info: + title: Tree API + version: 1.0.0 + description: API for working with tree data structures + +paths: + /tree: + get: + summary: Get tree + operationId: getTree + responses: + '200': + description: Successfully retrieved tree + content: + application/json: + schema: + $ref: '#/components/schemas/TreeNode' + +components: + schemas: + TreeNode: + type: object + properties: + value: + type: string + description: The value stored in this node + example: "root" + left: + description: Child nodes of this tree node + $ref: '#/components/schemas/TreeNode' + right: + description: Child nodes of this tree node + $ref: '#/components/schemas/TreeNode' diff --git a/packages/parsers/src/openapi/__test__/fixtures/file-upload/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/file-upload/openapi.yml new file mode 100644 index 0000000000..dfdcbb5d28 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/file-upload/openapi.yml @@ -0,0 +1,52 @@ +openapi: 3.0.3 +info: + title: Test file upload + version: 1.0.0 +paths: + /upload: + post: + summary: Upload a file + operationId: upload-file + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + description: The file to upload + maybe_file: + type: string + format: binary + description: An optional file to upload + required: [file] + /upload-with-content-type: + post: + summary: Upload a file + operationId: upload-file + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + description: The file to upload + maybe_file: + type: string + format: binary + description: An optional file to upload + metadata: + type: object + description: This is a metadata field + required: [file] + encoding: + file: + contentType: "application/octet-stream" + metadata: + contentType: "application/json" + diff --git a/packages/parsers/src/openapi/__test__/fixtures/float/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/float/openapi.yml new file mode 100644 index 0000000000..d40a5872af --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/float/openapi.yml @@ -0,0 +1,44 @@ +openapi: 3.0.3 +info: + title: Test spec for `float` types specified as number formats. + version: 1.0.0 + +paths: + /get: + get: + operationId: Get + requestBody: + required: true + description: A simple API request. + content: + application/json: + schema: + $ref: "#/components/schemas/Request" + responses: + '200': + description: A simple API response. + content: + application/json: + schema: + $ref: "#/components/schemas/Response" + +components: + schemas: + Request: + description: | + A generic request type used throughout the API. + properties: + id: + type: number + format: float + + Response: + description: | + A generic response type used throughout the API. + properties: + id: + type: number + format: float + value: + type: number + format: float \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/inline-path-parameters/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/inline-path-parameters/openapi.yml new file mode 100644 index 0000000000..bc3ee33d5e --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/inline-path-parameters/openapi.yml @@ -0,0 +1,87 @@ +openapi: 3.0.0 +info: + title: Inlined path parameters + version: 1.0.0 +paths: + /users/{user_id}: + get: + operationId: GetUser + description: Returns the user with the provided user ID. + parameters: + - in: path + name: user_id + schema: + type: string + required: true + /organizations/{organization_id}/users/{user_id}: + get: + operationId: GetOrganizationUser + description: Returns the user with the provided user ID. + parameters: + - in: path + name: organization_id + schema: + type: string + required: true + - in: path + name: user_id + schema: + type: string + required: true + - in: query + name: limit + schema: + type: integer + required: true + responses: + 200: + description: Successful response + content: + application/json: + schema: + type: object + properties: + results: + type: array + items: + type: string + /organizations/{organization_id}/search: + post: + operationId: Search + summary: Search an organization + description: "" + tags: + - Organizations + responses: + 200: + description: Successful response + content: + application/json: + schema: + type: object + properties: + results: + type: array + items: + type: string + parameters: + - in: path + name: id + schema: + type: string + description: Bookmark ID + required: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access: + type: string + enum: + - private + - public + description: Access level + additionalProperties: false diff --git a/packages/parsers/src/openapi/__test__/fixtures/inline-schema-reference/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/inline-schema-reference/openapi.yml new file mode 100644 index 0000000000..5129972f29 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/inline-schema-reference/openapi.yml @@ -0,0 +1,48 @@ +openapi: 3.0.0 +info: + title: Sample API + version: 1.0.0 +paths: + /example: + get: + summary: Get Example + responses: + '200': + description: Successful response + content: + application/json: + schema: + oneOf: + - $ref: "#/components/responses/NotFound/content/application~1json/schema" + - $ref: "#/components/schemas/Schema1" + - $ref: "#/components/schemas/Schema2" + - type: object + properties: + message: + type: string +components: + responses: + NotFound: + description: Resource not found + content: + application/json: + schema: + type: object + properties: + message: + type: string + schemas: + Schema1: + type: object + properties: + id: + type: integer + name: + type: string + Schema2: + type: object + properties: + email: + type: string + age: + type: integer diff --git a/packages/parsers/src/openapi/__test__/fixtures/json-string/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/json-string/openapi.yml new file mode 100644 index 0000000000..2b22117aa4 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/json-string/openapi.yml @@ -0,0 +1,16 @@ +openapi: 3.1.0 +info: + title: Test `json-string` example + version: 1.0.0 +paths: {} +components: + schemas: + User: + type: object + properties: + id: + type: string + format: uuid + metadata: + type: string + format: json-string diff --git a/packages/parsers/src/openapi/__test__/fixtures/multi-url-generators-yml/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/multi-url-generators-yml/openapi.yml new file mode 100644 index 0000000000..75aa96bda6 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/multi-url-generators-yml/openapi.yml @@ -0,0 +1,88 @@ +openapi: 3.0.0 +info: + title: User and Token API + version: 1.0.0 + description: API for retrieving user information and authentication tokens + +servers: + - url: https://a.com + +paths: + /users: + get: + summary: List Users + description: List information about all users + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/User' + '404': + description: User not found + '401': + description: Unauthorized + + /users/{userId}: + get: + x-fern-server-name: user + summary: Get user information + description: Retrieve detailed information about a specific user + parameters: + - name: userId + in: path + required: true + schema: + type: string + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/User' + '404': + description: User not found + '401': + description: Unauthorized + + /token: + get: + x-fern-server-name: auth + summary: Get authentication token + description: Retrieve an authentication token for the API + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Token' + '401': + description: Unauthorized + +components: + schemas: + User: + type: object + properties: + id: + type: string + username: + type: string + email: + type: string + createdAt: + type: string + format: date-time + + Token: + type: object + properties: + accessToken: + type: string + tokenType: + type: string + expiresIn: + type: integer \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/non-alphanumeric-characters/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/non-alphanumeric-characters/openapi.yml new file mode 100644 index 0000000000..6296f38d75 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/non-alphanumeric-characters/openapi.yml @@ -0,0 +1,35 @@ +openapi: 3.1.0 +info: + title: Enum of separator characters + version: 1.0.0 +paths: + /settings: + patch: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Settings' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Settings' + +components: + schemas: + Settings: + type: object + properties: + separator: + $ref: '#/components/schemas/DocumentIDSeparators' + DocumentIDSeparators: + type: string + enum: + - / # slash + - '-' # hyphen + - '|' # pipe + - . # dot + - '' # empty string diff --git a/packages/parsers/src/openapi/__test__/fixtures/nullable/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/nullable/openapi.yml new file mode 100644 index 0000000000..840637e94b --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/nullable/openapi.yml @@ -0,0 +1,140 @@ +openapi: 3.1.0 +info: + title: Nullable Properties API + version: 1.0.0 + +paths: + /users: + post: + summary: Create a user + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserCreate' + responses: + '200': + description: User created successfully + content: + application/json: + schema: + $ref: '#/components/schemas/User' + + put: + summary: Update a user + requestBody: + required: true + nullable: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserUpdate' + responses: + '200': + description: User updated successfully + content: + application/json: + schema: + $ref: '#/components/schemas/User' + + /users/{userId}: + get: + summary: Get a user + parameters: + - name: userId + in: path + required: true + schema: + type: string + - name: activated + in: query + required: true + nullable: true + schema: + type: string + - name: email + in: query + required: false + nullable: true + schema: + type: string + responses: + '200': + description: User retrieved successfully + content: + application/json: + schema: + $ref: '#/components/schemas/User' + +components: + schemas: + UserCreate: + type: object + properties: + name: + type: string + email: + type: string + settings: + $ref: '#/components/schemas/UserSettings' + nullable: true + + UserUpdate: + type: object + properties: + name: + type: string + email: + type: string + nullable: true + settings: + $ref: '#/components/schemas/UserSettings' + nullable: true + + User: + type: object + properties: + id: + type: string + name: + type: string + email: + type: string + createdAt: + type: string + format: date-time + nullable: true + settings: + $ref: '#/components/schemas/UserSettings' + nullable: true + stats: + $ref: '#/components/schemas/UserStats' + nullable: true + UserSettings: + type: object + properties: + theme: + type: string + notifications: + type: boolean + lastModified: + type: string + format: date-time + nullable: true + + UserStats: + type: object + properties: + totalLogins: + type: integer + nullable: true + lastLoginTime: + type: string + format: date-time + nullable: true + accountStatus: + type: string + enum: [active, suspended, deleted] + nullable: true + diff --git a/packages/parsers/src/openapi/__test__/fixtures/oauth/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/oauth/openapi.yml new file mode 100644 index 0000000000..a0f7207454 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/oauth/openapi.yml @@ -0,0 +1,80 @@ +openapi: 3.0.0 +info: + title: OAuth Token API + version: 1.0.0 + description: A simple API with an OAuth token endpoint accepting JSON input + +servers: + - url: https://api.example.com/v1 + +paths: + /oauth/token: + post: + x-fern-sdk-group-name: auth + x-fern-sdk-method-name: get-token + summary: Request an access token + description: Exchange credentials or refresh token for an access token + tags: + - OAuth + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + grant_type: + type: string + enum: [password, refresh_token, client_credentials] + description: The type of grant to request + username: + type: string + description: Required for password grant type + password: + type: string + description: Required for password grant type + refresh_token: + type: string + description: Required for refresh_token grant type + client_id: + type: string + description: The client identifier + client_secret: + type: string + description: The client secret + required: + - grant_type + - client_id + - client_secret + responses: + '200': + description: Successful token response + content: + application/json: + schema: + type: object + properties: + access_token: + type: string + token_type: + type: string + example: "Bearer" + expires_in: + type: integer + description: Token expiration time in seconds + refresh_token: + type: string + '400': + description: Bad request + '401': + description: Unauthorized + +components: + securitySchemes: + oauth2: + type: oauth2 + flows: + password: + tokenUrl: /oauth/token + clientCredentials: + tokenUrl: /oauth/token \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/only-include-referenced-schemas/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/only-include-referenced-schemas/openapi.yml new file mode 100644 index 0000000000..d5b09adb2c --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/only-include-referenced-schemas/openapi.yml @@ -0,0 +1,17297 @@ +--- +openapi: 3.0.1 +info: + title: Intercom API + version: '2.11' + description: The intercom API reference. + contact: + name: Intercom Developer Hub + url: https://developers.intercom.com + license: + name: MIT + url: https://spdx.org/licenses/MIT +paths: + "/me": + get: + summary: Identify an admin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Admins + operationId: identifyAdmin + description: "\nYou can view the currently authorised admin along with the embedded + app object (a \"workspace\" in legacy terminology).\n\n> \U0001F6A7 Single + Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for + your site, and you call the `/me` endpoint to identify the logged-in user, + you should not accept any sign-ins from users with unverified email addresses + as it poses a potential impersonation security risk.\n" + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin + id: '991267390' + email: admin1@email.com + name: Ciaran1 Lee + email_verified: true + app: + type: app + id_code: this_is_an_id1_that_should_be_at_least_40 + name: MyApp 1 + created_at: 1719492696 + secure: false + identity_verification: false + timezone: America/Los_Angeles + region: US + avatar: + type: avatar + image_url: https://static.intercomassets.com/assets/default-avatars/admins/128.png + has_inbox_seat: true + schema: + "$ref": "#/components/schemas/admin_with_app" + "/admins/{id}/away": + put: + summary: Set an admin to away + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given admin + schema: + type: integer + tags: + - Admins + operationId: setAwayAdmin + description: You can set an Admin as away for the Inbox. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin + id: '991267391' + name: Ciaran2 Lee + email: admin2@email.com + away_mode_enabled: true + away_mode_reassign: true + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin" + '404': + description: Admin not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 9818bd03-9cc6-4ab8-8e7c-20a45ac58e97 + errors: + - code: admin_not_found + message: Admin for admin_id not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 18722269-a019-46c4-87d7-50d0f6f8a990 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - away_mode_enabled + - away_mode_reassign + properties: + away_mode_enabled: + type: boolean + description: Set to "true" to change the status of the admin to + away. + example: true + default: true + away_mode_reassign: + type: boolean + description: Set to "true" to assign any new conversation replies + to your default inbox. + example: false + default: false + examples: + successful_response: + summary: Successful response + value: + away_mode_enabled: true + away_mode_reassign: true + admin_not_found: + summary: Admin not found + value: + away_mode_enabled: true + away_mode_reassign: true + unauthorized: + summary: Unauthorized + value: + away_mode_enabled: true + away_mode_reassign: true + "/admins/activity_logs": + get: + summary: List all activity logs + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: created_at_after + in: query + required: true + description: The start date that you request data for. It must be formatted + as a UNIX timestamp. + example: '1677253093' + schema: + type: string + - name: created_at_before + in: query + required: false + description: The end date that you request data for. It must be formatted + as a UNIX timestamp. + example: '1677861493' + schema: + type: string + tags: + - Admins + operationId: listActivityLogs + description: You can get a log of activities by all admins in an app. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: activity_log.list + pages: + type: pages + next: + page: 1 + per_page: 20 + total_pages: 1 + activity_logs: + - id: ddee3a18-0032-4061-b9b9-26230c3dd5f7 + performed_by: + type: admin + id: '991267395' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + message: + id: 123 + title: Initial message title + before: Initial message title + after: Eventual message title + created_at: 1719492702 + activity_type: message_state_change + activity_description: Ciaran5 Lee changed your Initial message + title message from Initial message title to Eventual message + title. + - id: 5eec951b-db7a-4b5b-add5-95ffc90969b6 + performed_by: + type: admin + id: '991267395' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1719492702 + activity_type: app_name_change + activity_description: Ciaran5 Lee changed your app name from + before to after. + schema: + "$ref": "#/components/schemas/activity_log_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 06d9eefd-2b3a-48f7-938a-5a10383a4ebf + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/admins": + get: + summary: List all admins + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Admins + operationId: listAdmins + description: You can fetch a list of admins for a given workspace. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin.list + admins: + - type: admin + email: admin7@email.com + id: '991267397' + name: Ciaran7 Lee + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4ba8121e-4a4a-4668-adb2-363c561f3c52 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/admins/{id}": + get: + summary: Retrieve an admin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given admin + example: 123 + schema: + type: integer + tags: + - Admins + operationId: retrieveAdmin + description: You can retrieve the details of a single admin. + responses: + '200': + description: Admin found + content: + application/json: + examples: + Admin found: + value: + type: admin + id: '991267399' + name: Ciaran9 Lee + email: admin9@email.com + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin" + '404': + description: Admin not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 989bdb0b-1e8c-46cc-8953-9733dad40562 + errors: + - code: admin_not_found + message: Admin not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 83978032-1473-4696-b755-b497d46a23cf + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/articles": + get: + summary: List all articles + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Articles + operationId: listArticles + description: "You can fetch a list of all articles by making a GET request to + `https://api.intercom.io/articles`.\n\n> \U0001F4D8 How are the articles sorted + and ordered?\n>\n> 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.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + type: pages + page: 1 + per_page: 25 + total_pages: 1 + total_count: 1 + data: + - id: '39' + type: article + workspace_id: this_is_an_id33_that_should_be_at_least_4 + parent_id: 143 + parent_type: collection + parent_ids: [] + title: This is the article title + description: '' + body: '' + author_id: 991267402 + state: published + created_at: 1719492707 + updated_at: 1719492707 + url: http://help-center.test/myapp-33/en/articles/39-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 86d69044-5966-428e-9a40-2b39fba3f823 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Articles + operationId: createArticle + description: You can create a new article by making a POST request to `https://api.intercom.io/articles`. + responses: + '200': + description: article created + content: + application/json: + examples: + article created: + value: + id: '42' + type: article + workspace_id: this_is_an_id37_that_should_be_at_least_4 + parent_id: 145 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: Thanks for everything + description: Description of the Article + body:

Body of the Article

+ author_id: 991267407 + state: published + created_at: 1719492710 + updated_at: 1719492710 + url: http://help-center.test/myapp-37/en/articles/42-thanks-for-everything + schema: + "$ref": "#/components/schemas/article" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: e0ea220d-8030-4e0c-9fa9-6b40e9ed4fbd + errors: + - code: parameter_not_found + message: author_id must be in the main body or default locale + translated_content object + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f223a1d9-5377-4337-92bb-00fb39157f11 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_article_request" + examples: + article_created: + summary: article created + value: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + author_id: 991267407 + state: 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: published + bad_request: + summary: Bad Request + value: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + state: published + "/articles/{id}": + get: + summary: Retrieve an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: retrieveArticle + description: You can fetch the details of a single article by making a GET request + to `https://api.intercom.io/articles/`. + responses: + '200': + description: Article found + content: + application/json: + examples: + Article found: + value: + id: '45' + type: article + workspace_id: this_is_an_id43_that_should_be_at_least_4 + parent_id: 148 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: This is the article title + description: '' + body: '' + author_id: 991267412 + state: published + created_at: 1719492712 + updated_at: 1719492712 + url: http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article" + '404': + description: Article not found + content: + application/json: + examples: + Article not found: + value: + type: error.list + request_id: 99c73902-e8ea-4872-b412-1d55ce4582fb + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 62ab4791-7e4d-4400-a56b-b06a0ce3ba1a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: updateArticle + description: You can update the details of a single article by making a PUT + request to `https://api.intercom.io/articles/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '48' + type: article + workspace_id: this_is_an_id49_that_should_be_at_least_4 + parent_id: 151 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: Christmas is here! + description: '' + body:

New gifts in store for the jolly season

+ author_id: 991267418 + state: published + created_at: 1719492714 + updated_at: 1719492714 + url: http://help-center.test/myapp-49/en/articles/48-christmas-is-here + schema: + "$ref": "#/components/schemas/article" + '404': + description: Article Not Found + content: + application/json: + examples: + Article Not Found: + value: + type: error.list + request_id: 891b6ff4-181f-4b98-861b-d34ef16bfc4b + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 15b4f214-c670-43d7-ad8f-648791fddf9b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_article_request" + examples: + successful: + summary: successful + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + article_not_found: + summary: Article Not Found + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + delete: + summary: Delete an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: deleteArticle + description: You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '51' + object: article + deleted: true + schema: + "$ref": "#/components/schemas/deleted_article_object" + '404': + description: Article Not Found + content: + application/json: + examples: + Article Not Found: + value: + type: error.list + request_id: 60da5f23-613c-4f84-84bd-e9dbd3d67187 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 85d43c53-f28f-4295-b937-9a43ea71d0c3 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/articles/search": + get: + summary: Search for articles + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: phrase + in: query + required: false + description: The phrase within your articles to search for. + example: Getting started + schema: + type: string + - name: state + in: query + required: false + description: The state of the Articles returned. One of `published`, `draft` + or `all`. + example: published + schema: + type: string + - name: help_center_id + in: query + required: false + description: The ID of the Help Center to search in. + example: 123 + schema: + type: integer + - name: highlight + in: query + required: false + description: Return a highlighted version of the matching content within your + articles. Refer to the response schema for more details. + example: false + schema: + type: boolean + tags: + - Articles + operationId: searchArticles + description: You can search for articles by making a GET request to `https://api.intercom.io/articles/search`. + responses: + '200': + description: Search successful + content: + application/json: + examples: + Search successful: + value: + type: list + total_count: 1 + data: + articles: + - id: '55' + type: article + workspace_id: this_is_an_id61_that_should_be_at_least_4 + parent_id: + parent_type: + parent_ids: [] + title: Title 1 + description: '' + body: '' + author_id: 991267431 + state: draft + created_at: 1719492719 + updated_at: 1719492719 + url: + highlights: [] + pages: + type: pages + page: 1 + total_pages: 1 + per_page: 10 + schema: + "$ref": "#/components/schemas/article_search_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 626c6766-ee1a-489d-b87a-230d9b980c7d + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/collections": + get: + summary: List all collections + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: listAllCollections + description: | + You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`. + + Collections 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 collections first. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - id: '159' + workspace_id: this_is_an_id65_that_should_be_at_least_4 + name: English collection title + url: http://help-center.test/myapp-65/collection-17 + order: 17 + created_at: 1719492720 + updated_at: 1719492720 + description: english collection description + icon: bookmark + parent_id: + help_center_id: 79 + - id: '160' + workspace_id: this_is_an_id65_that_should_be_at_least_4 + name: English section title + url: http://help-center.test/myapp-65/section-1 + order: 1 + created_at: 1719492720 + updated_at: 1719492720 + description: + icon: bookmark + parent_id: '159' + help_center_id: + total_count: 2 + pages: + type: pages + page: 1 + per_page: 20 + total_pages: 1 + schema: + "$ref": "#/components/schemas/collection_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ccedcb48-7d08-4cc9-bcff-0622f70daf74 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: createCollection + description: You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.` + responses: + '200': + description: collection created + content: + application/json: + examples: + collection created: + value: + id: '165' + workspace_id: this_is_an_id69_that_should_be_at_least_4 + name: Thanks for everything + url: http://help-center.test/myapp-69/ + order: 1 + created_at: 1719492721 + updated_at: 1719492721 + description: '' + icon: book-bookmark + parent_id: + help_center_id: 81 + schema: + "$ref": "#/components/schemas/collection" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: 1f4fd741-8681-4c21-911a-47d7bb39d080 + errors: + - code: parameter_not_found + message: Name is a required parameter. + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 8afa14e4-0e7c-4159-8aab-dfa3dcb6a8b4 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_collection_request" + examples: + collection_created: + summary: collection created + value: + name: Thanks for everything + bad_request: + summary: Bad Request + value: + description: Missing required parameter + "/help_center/collections/{id}": + get: + summary: Retrieve a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: retrieveCollection + description: You can fetch the details of a single collection by making a GET + request to `https://api.intercom.io/help_center/collections/`. + responses: + '200': + description: Collection found + content: + application/json: + examples: + Collection found: + value: + id: '170' + workspace_id: this_is_an_id75_that_should_be_at_least_4 + name: English collection title + url: http://help-center.test/myapp-75/collection-22 + order: 22 + created_at: 1719492723 + updated_at: 1719492723 + description: english collection description + icon: bookmark + parent_id: + help_center_id: 84 + schema: + "$ref": "#/components/schemas/collection" + '404': + description: Collection not found + content: + application/json: + examples: + Collection not found: + value: + type: error.list + request_id: 2970f0f3-7020-4382-8892-eac24818ca88 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: bf1acd76-8c6e-45f4-8dbe-54391843270a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: updateCollection + description: You can update the details of a single collection by making a PUT + request to `https://api.intercom.io/collections/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '176' + workspace_id: this_is_an_id81_that_should_be_at_least_4 + name: Update collection name + url: http://help-center.test/myapp-81/collection-25 + order: 25 + created_at: 1719492724 + updated_at: 1719492724 + description: english collection description + icon: folder + parent_id: + help_center_id: 87 + schema: + "$ref": "#/components/schemas/collection" + '404': + description: Collection Not Found + content: + application/json: + examples: + Collection Not Found: + value: + type: error.list + request_id: 35e7f185-f547-4ae1-a23d-afc9027fc5a6 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 67002700-07f8-4a56-a9bc-464254c3a5bd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_collection_request" + examples: + successful: + summary: successful + value: + name: Update collection name + collection_not_found: + summary: Collection Not Found + value: + name: Update collection name + delete: + summary: Delete a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: deleteCollection + description: You can delete a single collection by making a DELETE request to + `https://api.intercom.io/collections/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '182' + object: collection + deleted: true + schema: + "$ref": "#/components/schemas/deleted_collection_object" + '404': + description: collection Not Found + content: + application/json: + examples: + collection Not Found: + value: + type: error.list + request_id: a35712b4-90b6-47fb-843d-757d9fdd81e6 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e00bc89b-b9a9-4bc2-84a0-5c9d4710bfcf + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/help_centers/{id}": + get: + summary: Retrieve a Help Center + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: retrieveHelpCenter + description: You can fetch the details of a single Help Center by making a GET + request to `https://api.intercom.io/help_center/help_center/`. + responses: + '200': + description: Collection found + content: + application/json: + examples: + Collection found: + value: + id: '93' + workspace_id: this_is_an_id93_that_should_be_at_least_4 + created_at: 1719492727 + updated_at: 1719492727 + identifier: help-center-1 + website_turned_on: false + display_name: Intercom Help Center + schema: + "$ref": "#/components/schemas/help_center" + '404': + description: Collection not found + content: + application/json: + examples: + Collection not found: + value: + type: error.list + request_id: c6e7d3f6-8a46-460e-8264-e07c2e7302aa + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 794a475b-0155-40b2-a288-ba0d48fdbd3f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/help_centers": + get: + summary: List all Help Centers + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: listHelpCenters + description: You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`. + responses: + '200': + description: Help Centers found + content: + application/json: + examples: + Help Centers found: + value: + type: list + data: [] + schema: + "$ref": "#/components/schemas/help_center_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c96a4779-a06d-45bb-aa39-eb96c587c2c7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies": + post: + summary: Create or Update a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Companies + operationId: createOrUpdateCompany + description: | + You can create or update a company. + + Companies will be only visible in Intercom when there is at least one associated user. + + Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated. + + {% admonition type="attention" name="Using `company_id`" %} + You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: company_remote_id + id: 667d607c8a68186f43bafd1e + app_id: this_is_an_id116_that_should_be_at_least_ + name: my company + remote_created_at: 1374138000 + created_at: 1719492732 + updated_at: 1719492732 + monthly_spend: 0 + session_count: 0 + user_count: 0 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: + creation_source: api + schema: + "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: + errors: + - code: bad_request + message: bad 'test' parameter + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 9b0d6fb9-d2d7-4904-a13c-97557a802323 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_or_update_company_request" + examples: + successful: + summary: Successful + value: + company_id: company_remote_id + name: my company + remote_created_at: 1374138000 + bad_request: + summary: Bad Request + value: + test: invalid + get: + summary: Retrieve companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: name + in: query + required: false + description: The `name` of the company to filter by. + example: my company + schema: + type: string + - name: company_id + in: query + required: false + description: The `company_id` of the company to filter by. + example: '12345' + schema: + type: string + - name: tag_id + in: query + required: false + description: The `tag_id` of the company to filter by. + example: '678910' + schema: + type: string + - name: segment_id + in: query + required: false + description: The `segment_id` of the company to filter by. + example: '98765' + schema: + type: string + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to display per page. Defaults to 15 + example: 15 + schema: + type: integer + tags: + - Companies + operationId: retrieveCompany + description: | + You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + + You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 667d607e8a68186f43bafd26 + app_id: this_is_an_id122_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1719492734 + created_at: 1719492734 + updated_at: 1719492734 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 15 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/company_list" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: c97dd75f-a434-4c83-a8e8-c4d1887d6c48 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6ef54f1c-70a4-4779-b3a6-29e4fd65d9dd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}": + get: + summary: Retrieve a company by ID + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: RetrieveACompanyById + description: You can fetch a single company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d60808a68186f43bafd31 + app_id: this_is_an_id128_that_should_be_at_least_ + name: company1 + remote_created_at: 1719492736 + created_at: 1719492736 + updated_at: 1719492736 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: b49593ed-49a6-4497-8fb7-220ff74527f6 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c4e2fcb8-815e-4bee-80c7-9d5b1ab0f6fe + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: UpdateCompany + description: | + You can update a single company using the Intercom provisioned `id`. + + {% admonition type="attention" name="Using `company_id`" %} + When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d60828a68186f43bafd3b + app_id: this_is_an_id134_that_should_be_at_least_ + name: company2 + remote_created_at: 1719492738 + created_at: 1719492738 + updated_at: 1719492738 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: b1ce72df-630f-4925-b212-fca6e833eb8d + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3f26a216-ddff-4782-9529-514f5bad56ea + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: deleteCompany + description: You can delete a single company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 667d60848a68186f43bafd45 + object: company + deleted: true + schema: + "$ref": "#/components/schemas/deleted_company_object" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 35a9b551-331e-499e-a63f-20396bfd29f5 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0a1a5065-69fe-47a4-9804-4cb2347671ef + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}/contacts": + get: + summary: List attached contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + - Contacts + operationId: ListAttachedContacts + description: You can fetch a list of all contacts that belong to a company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 50 + total_pages: 0 + schema: + "$ref": "#/components/schemas/company_attached_contacts" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: a6381081-a166-4e8e-952d-38bb2cd1c2b4 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: fe20b681-f988-4154-bec9-a5087fe0842e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}/segments": + get: + summary: List attached segments for companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: ListAttachedSegmentsForCompanies + description: You can fetch a list of all segments that belong to a company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: [] + schema: + "$ref": "#/components/schemas/company_attached_segments" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 22add598-fd33-4c34-971f-cf215117aab3 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 66fcc654-48ed-4f53-824e-831b5c96c9dc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/list": + post: + summary: List all companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to return per page. Defaults to 15 + example: 15 + schema: + type: integer + - name: order + in: query + required: false + description: "`asc` or `desc`. Return the companies in ascending or descending + order. Defaults to desc" + example: desc + schema: + type: string + tags: + - Companies + operationId: listAllCompanies + description: | + You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. + + Note that the API does not include companies who have no associated users in list responses. + + When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 667d608a8a68186f43bafd61 + app_id: this_is_an_id158_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1719492746 + created_at: 1719492746 + updated_at: 1719492746 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 15 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/company_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6f8cb4ca-9a95-43bd-aee1-597b85d1d13f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/scroll": + get: + summary: Scroll over all companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: scroll_param + in: query + required: false + description: '' + schema: + type: string + tags: + - Companies + operationId: scrollOverAllCompanies + description: |2 + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + + - Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. + - If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail + - If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + + {% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. + {% /admonition %} + {% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 667d608b8a68186f43bafd67 + app_id: this_is_an_id162_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1719492747 + created_at: 1719492747 + updated_at: 1719492747 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + total_count: + scroll_param: 12d403b5-dc79-47b5-8ea1-01a5ac8cb6cc + schema: + "$ref": "#/components/schemas/company_scroll" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4b3ca8b1-8983-4fb8-abc5-b20a4ece5d32 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}/companies": + post: + summary: Attach a Contact to a Company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the contact which is given by Intercom + schema: + type: string + tags: + - Companies + - Contacts + operationId: attachContactToACompany + description: You can attach a company to a single contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d608d8a68186f43bafd70 + app_id: this_is_an_id166_that_should_be_at_least_ + name: company6 + remote_created_at: 1719492749 + created_at: 1719492749 + updated_at: 1719492749 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: 9297dcfc-1896-43a3-a3f9-131238422ed2 + errors: + - code: parameter_not_found + message: company not specified + schema: + "$ref": "#/components/schemas/error" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 32d121d8-fcbf-4c59-9c60-204f7d602f36 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 99739bbd-2dbe-4ce3-ae91-af23379b5cd7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + x-fern-property-name: companyId + type: string + description: The unique identifier for the company which is given + by Intercom + example: 58a430d35458202d41b1e65b + examples: + successful: + summary: Successful + value: + id: 667d608d8a68186f43bafd70 + bad_request: + summary: Bad Request + value: + company_not_found: + summary: Company Not Found + value: + id: '123' + get: + summary: List attached companies for contact + parameters: + - name: id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Companies + operationId: listCompaniesForAContact + description: You can fetch a list of companies that are associated to a contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: company + company_id: '1' + id: 667d60938a68186f43bafd91 + app_id: this_is_an_id182_that_should_be_at_least_ + name: company12 + remote_created_at: 1719492755 + created_at: 1719492755 + updated_at: 1719492755 + last_request_at: 1719319955 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 50 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/contact_attached_companies" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: b9d7374d-1780-4668-bb62-0e1ff9cdab45 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d211ec8c-df9b-420c-86df-23c27ad54bc5 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/companies/{id}": + delete: + summary: Detach a contact from a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + required: true + description: The unique identifier for the contact which is given by Intercom + example: 58a430d35458202d41b1e65b + schema: + type: string + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 58a430d35458202d41b1e65b + schema: + type: string + tags: + - Companies + - Contacts + operationId: detachContactFromACompany + description: You can detach a company from a single contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d60918a68186f43bafd80 + app_id: this_is_an_id174_that_should_be_at_least_ + name: company8 + remote_created_at: 1719492753 + created_at: 1719492753 + updated_at: 1719492753 + monthly_spend: 0 + session_count: 0 + user_count: 0 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Contact Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: cd4f1648-724c-45f0-b6e1-72a1bc6479ee + errors: + - code: company_not_found + message: Company Not Found + Contact Not Found: + value: + type: error.list + request_id: d316defc-0a2f-49e7-b8ff-4cb6ccf46c90 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d8c1ab2d-4044-4c4f-98f0-176860747112 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}/notes": + get: + summary: List all notes + parameters: + - name: id + in: path + required: true + description: The unique identifier of a contact. + schema: + type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Notes + - Contacts + operationId: listNotes + description: You can fetch a list of notes that are associated to a contact. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: list + data: + - type: note + id: '29' + created_at: 1718887958 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '28' + created_at: 1718801558 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '27' + created_at: 1718801558 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + total_count: 3 + pages: + type: pages + next: + page: 1 + per_page: 50 + total_pages: 1 + schema: + "$ref": "#/components/schemas/note_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: e93f90a6-4c85-4dbf-b063-96b649318371 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a note + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given contact. + example: '123' + schema: + type: integer + tags: + - Notes + - Contacts + operationId: createNote + description: You can add a note to a single contact. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: note + id: '34' + created_at: 1719492759 + contact: + type: contact + id: 667d60978a68186f43bafd9e + author: + type: admin + id: '991267493' + name: Ciaran103 Lee + email: admin103@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

Hello

" + schema: + "$ref": "#/components/schemas/note" + '404': + description: Contact not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: d7c69ce6-3195-46be-b2cb-0dce355d2919 + errors: + - code: not_found + message: Resource Not Found + Contact not found: + value: + type: error.list + request_id: 2e3bd274-9ac6-43c3-a419-bcc8e6a03a1d + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - body + properties: + body: + type: string + description: The text of the note. + example: New note + contact_id: + type: string + description: The unique identifier of a given contact. + example: '123' + admin_id: + type: string + description: The unique identifier of a given admin. + example: '123' + examples: + successful_response: + summary: Successful response + value: + contact_id: 667d60978a68186f43bafd9e + admin_id: 991267493 + body: Hello + admin_not_found: + summary: Admin not found + value: + contact_id: 667d60988a68186f43bafd9f + admin_id: 123 + body: Hello + contact_not_found: + summary: Contact not found + value: + contact_id: 123 + admin_id: 991267495 + body: Hello + "/contacts/{contact_id}/segments": + get: + summary: List attached segments for contact + parameters: + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Segments + operationId: listSegmentsForAContact + description: You can fetch a list of segments that are associated to a contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: segment + id: 667d60998a68186f43bafda1 + name: segment + created_at: 1719492761 + updated_at: 1719492761 + person_type: user + schema: + "$ref": "#/components/schemas/contact_segments" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 7d4ab1a9-5990-4338-b5d9-0f3f55f1acb7 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d2927c64-9c5a-4593-997b-381f8c2356ea + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/subscriptions": + get: + summary: List subscriptions for a contact + parameters: + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Subscription Types + operationId: listSubscriptionsForAContact + description: | + You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + This will return a list of Subscription Type objects that the contact is associated with. + + The data property will show a combined list of: + + 1.Opt-out subscription types that the user has opted-out from. + 2.Opt-in subscription types that the user has opted-in to receiving. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: subscription + id: '93' + state: live + consent_type: opt_out + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - email + - type: subscription + id: '95' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 3f481052-cf49-4b95-a492-734223865981 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 82a95655-569d-4e5d-b0d9-f8a6c7a379f3 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Add subscription to a contact + tags: + - Subscription Types + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: attachSubscriptionTypeToContact + description: | + You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + + 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. + + 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. + + This will return a subscription type model for the subscription type that was added to the contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: subscription + id: '108' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type" + '404': + description: Resource not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: cf0f6fd6-7c5e-492b-909d-f60b35eea1c4 + errors: + - code: not_found + message: User Not Found + Resource not found: + value: + type: error.list + request_id: 3f852f45-1a80-4ade-9bc6-72b377d2bbd8 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 377d162e-82a5-4148-a26f-29c9c760dadc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - consent_type + properties: + id: + type: string + description: The unique identifier for the subscription which is + given by Intercom + example: '37846' + consent_type: + type: string + description: The consent_type of a subscription, opt_out or opt_in. + example: opt_in + examples: + successful: + summary: Successful + value: + id: 108 + consent_type: opt_in + contact_not_found: + summary: Contact not found + value: + id: 112 + consent_type: opt_in + resource_not_found: + summary: Resource not found + value: + id: invalid_id + consent_type: opt_in + "/contacts/{contact_id}/subscriptions/{id}": + delete: + summary: Remove subscription from a contact + tags: + - Subscription Types + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the subscription type which is given + by Intercom + example: '37846' + required: true + schema: + type: string + operationId: detachSubscriptionTypeToContact + description: You can remove a specific subscription from a contact. This will + return a subscription type model for the subscription type that was removed + from the contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: subscription + id: '124' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type" + '404': + description: Resource not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 7bc429e4-e887-4f53-b69c-94e6e55d2125 + errors: + - code: not_found + message: User Not Found + Resource not found: + value: + type: error.list + request_id: 66ebc1f5-5e02-4584-8028-f2559a41e8df + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 99fba0c6-2252-4658-abd2-1d2ff16a508b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/tags": + get: + summary: List tags attached to a contact + tags: + - Contacts + - Tags + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: listTagsForAContact + description: You can fetch a list of all tags that are attached to a specific + contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: tag + id: '93' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 2b513026-b78c-4c67-b073-da0266f62cc7 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 97383559-0fb0-4084-8a9a-8e3407c46108 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Add tag to a contact + tags: + - Tags + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: attachTagToContact + description: You can tag a specific contact. This will return a tag object for + the tag that was added to the contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '94' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 1bbd7e4b-718e-46f4-b682-a429aea78f01 + errors: + - code: not_found + message: User Not Found + Tag not found: + value: + type: error.list + request_id: a1a28017-728a-423b-adc0-2705d375f533 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 63a2828f-107e-4d51-9398-a220b81a7bce + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + examples: + successful: + summary: successful + value: + id: 94 + contact_not_found: + summary: Contact not found + value: + id: 95 + tag_not_found: + summary: Tag not found + value: + id: '123' + "/contacts/{contact_id}/tags/{id}": + delete: + summary: Remove tag from a contact + tags: + - Tags + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string + operationId: detachTagFromContact + description: You can remove tag from a specific contact. This will return a + tag object for the tag that was removed from the contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '97' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 6f735483-c309-4e94-b9ab-143aedc0c691 + errors: + - code: not_found + message: User Not Found + Tag not found: + value: + type: error.list + request_id: 9e780671-29b3-4913-b4be-15234ea0bc6a + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e97d9f1b-8c9e-4caf-b473-3bce411c697e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}": + put: + summary: Update a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: UpdateContact + description: You can update an existing contact (ie. user or lead). + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60a88a68186f43bafdb8 + workspace_id: this_is_an_id248_that_should_be_at_least_ + external_id: '70' + role: user + email: joebloggs@intercom.io + phone: + name: joe bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492776 + updated_at: 1719492776 + signed_up_at: 1719492776 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b1b88e2d-938c-4a26-b65d-26ff65a0af36 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/update_contact_request" + examples: + successful: + summary: successful + value: + email: joebloggs@intercom.io + name: joe bloggs + get: + summary: Get a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: ShowContact + description: You can fetch the details of a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60a98a68186f43bafdb9 + workspace_id: this_is_an_id252_that_should_be_at_least_ + external_id: '70' + role: user + email: joe@bloggs.com + phone: + name: Joe Bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492777 + updated_at: 1719492777 + signed_up_at: 1719492777 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f70085f1-f655-43ee-9585-d2061b260fcd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + required: true + schema: + type: string + tags: + - Contacts + operationId: DeleteContact + description: You can delete a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 667d60aa8a68186f43bafdba + external_id: '70' + type: contact + deleted: true + schema: + "$ref": "#/components/schemas/contact_deleted" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0bce3945-d2ec-4b8e-a790-b16fd52d9f11 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/merge": + post: + summary: Merge a lead and a user + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: MergeContact + description: You can merge a contact with a `role` of `lead` into a contact + with a `role` of `user`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60ac8a68186f43bafdbc + workspace_id: this_is_an_id260_that_should_be_at_least_ + external_id: '70' + role: user + email: joe@bloggs.com + phone: + name: Joe Bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492780 + updated_at: 1719492780 + signed_up_at: 1719492780 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 57b64228-0e60-4e35-833d-39c4e4067dde + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/merge_contacts_request" + examples: + successful: + summary: successful + value: + from: 667d60ac8a68186f43bafdbb + into: 667d60ac8a68186f43bafdbc + "/contacts/search": + post: + summary: Search contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: SearchContacts + description: | + You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + + To search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`. + + This will accept a query object in the body which will define your filters in order to search for contacts. + + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + ### Contact Creation Delay + + If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiple's there can be: + * There's a limit of max 2 nested filters + * There's a limit of max 15 filters for each AND or OR group + + ### Searching for Timestamp Fields + + All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly. + + ### Accepted Fields + + Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + + | Field | Type | + | ---------------------------------- | ------------------------------ | + | id | String | + | role | String
Accepts user or lead | + | name | String | + | avatar | String | + | owner_id | Integer | + | email | String | + | email_domain | String | + | phone | String | + | formatted_phone | String | + | external_id | String | + | created_at | Date (UNIX Timestamp) | + | signed_up_at | Date (UNIX Timestamp) | + | updated_at | Date (UNIX Timestamp) | + | last_seen_at | Date (UNIX Timestamp) | + | last_contacted_at | Date (UNIX Timestamp) | + | last_replied_at | Date (UNIX Timestamp) | + | last_email_opened_at | Date (UNIX Timestamp) | + | last_email_clicked_at | Date (UNIX Timestamp) | + | language_override | String | + | browser | String | + | browser_language | String | + | os | String | + | location.country | String | + | location.region | String | + | location.city | String | + | unsubscribed_from_emails | Boolean | + | marked_email_as_spam | Boolean | + | has_hard_bounced | Boolean | + | ios_last_seen_at | Date (UNIX Timestamp) | + | ios_app_version | String | + | ios_device | String | + | ios_app_device | String | + | ios_os_version | String | + | ios_app_name | String | + | ios_sdk_version | String | + | android_last_seen_at | Date (UNIX Timestamp) | + | android_app_version | String | + | android_device | String | + | android_app_name | String | + | andoid_sdk_version | String | + | segment_id | String | + | tag_id | String | + | custom_attributes.{attribute_name} | String | + + ### Accepted Operators + + {% admonition type="attention" name="Searching based on `created_at`" %} + You cannot use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :------------------------------- | :--------------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In
Shortcut for `OR` queries
Values must be in Array | + | NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array | + | > | Integer
Date (UNIX Timestamp) | Greater than | + | < | Integer
Date (UNIX Timestamp) | Lower than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 5 + total_pages: 0 + schema: + "$ref": "#/components/schemas/contact_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 2b28c47b-8fa3-4e17-8fc1-6ba80f1cc844 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: created_at + operator: ">" + value: '1306054154' + pagination: + per_page: 5 + "/contacts": + get: + summary: List all contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: ListContacts + description: | + You can fetch a list of all contacts (ie. users or leads) in your workspace. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 10 + total_pages: 0 + schema: + "$ref": "#/components/schemas/contact_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d5bac7ff-7961-4fe5-8aed-6f1b031b38af + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: CreateContact + description: You can create a new contact (ie. user or lead). + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60b08a68186f43bafdbf + workspace_id: this_is_an_id272_that_should_be_at_least_ + external_id: + role: user + email: joebloggs@intercom.io + phone: + name: + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492784 + updated_at: 1719492784 + signed_up_at: + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c18ca0d4-ad2c-41e7-9a71-1df806f9c954 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/create_contact_request" + examples: + successful: + summary: successful + value: + email: joebloggs@intercom.io + "/contacts/{id}/archive": + post: + summary: Archive contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: ArchiveContact + description: You can archive a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 667d60b18a68186f43bafdc0 + external_id: '70' + type: contact + archived: true + schema: + "$ref": "#/components/schemas/contact_archived" + "/contacts/{id}/unarchive": + post: + summary: Unarchive contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: UnarchiveContact + description: You can unarchive a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 667d60b28a68186f43bafdc1 + external_id: '70' + type: contact + archived: false + schema: + "$ref": "#/components/schemas/contact_unarchived" + "/conversations/{conversation_id}/tags": + post: + summary: Add tag to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + description: conversation_id + example: '64619700005694' + required: true + schema: + type: string + tags: + - Tags + - Conversations + operationId: attachTagToConversation + description: You can tag a specific conversation. This will return a tag object + for the tag that was added to the conversation. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '99' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Conversation not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: 840d35aa-2414-402a-b3c6-763a410e0d16 + errors: + - code: not_found + message: Conversation not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 95cacea0-4744-4de8-a2bf-da4419f75732 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - admin_id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '780' + examples: + successful: + summary: successful + value: + id: 99 + admin_id: 991267526 + conversation_not_found: + summary: Conversation not found + value: + id: 100 + admin_id: 991267528 + "/conversations/{conversation_id}/tags/{id}": + delete: + summary: Remove tag from a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + description: conversation_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: id + example: '7522907' + required: true + schema: + type: string + tags: + - Tags + - Conversations + operationId: detachTagFromConversation + description: You can remove tag from a specific conversation. This will return + a tag object for the tag that was removed from the conversation. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '102' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: f78f63ba-911d-47b8-a389-b33e3ccbe77e + errors: + - code: not_found + message: Conversation not found + Tag not found: + value: + type: error.list + request_id: 0d00d069-2cf1-496f-b887-a4db74ee320d + errors: + - code: tag_not_found + message: Tag not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f083d6b1-e9d2-43b3-86df-67539007fc3e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - admin_id + properties: + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '123' + examples: + successful: + summary: successful + value: + admin_id: 991267530 + conversation_not_found: + summary: Conversation not found + value: + admin_id: 991267532 + tag_not_found: + summary: Tag not found + value: + admin_id: 991267533 + "/conversations": + get: + summary: List all conversations + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: per_page + in: query + schema: + type: integer + default: 20 + maximum: 150 + required: false + description: How many results per page + - name: starting_after + in: query + required: false + description: String used to get the next page of conversations. + schema: + type: string + tags: + - Conversations + operationId: listConversations + description: | + You can fetch a list of all conversations. + + You can optionally request the result page size and the cursor to start after to fetch the result. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: conversation.list + pages: + type: pages + page: 1 + per_page: 20 + total_pages: 1 + total_count: 1 + conversations: + - type: conversation + id: '335' + created_at: 1719492795 + updated_at: 1719492795 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918241' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267536' + name: Ciaran143 Lee + email: admin143@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60bb8a68186f43bafdc5 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 18db64a8-7a08-4967-9ec6-0416178306f9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: a91eac55-8d70-454d-a01d-c6bb875aaa35 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + post: + summary: Creates a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: createConversation + description: |+ + You can create a conversation that has been initiated by a contact (ie. user or lead). + The conversation can be an in-app message only. + + {% admonition type="info" name="Sending for visitors" %} + You can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`. + This visitor will be automatically converted to a contact with a lead role once the conversation is created. + {% /admonition %} + + This will return the Message model that has been created. + + responses: + '200': + description: conversation created + content: + application/json: + examples: + conversation created: + value: + type: user_message + id: '403918251' + created_at: 1719492819 + body: Hello there + message_type: inapp + conversation_id: '363' + schema: + "$ref": "#/components/schemas/message" + '404': + description: Contact Not Found + content: + application/json: + examples: + Contact Not Found: + value: + type: error.list + request_id: ed0ab0c5-57b8-4413-a7a9-bbc134b40876 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: af9757fc-4e1d-463c-ac9d-788503f04a95 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: c7a35217-6720-48bd-a2ae-c2acb5adea30 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_conversation_request" + examples: + conversation_created: + summary: conversation created + value: + from: + type: user + id: 667d60d18a68186f43bafddd + body: Hello there + contact_not_found: + summary: Contact Not Found + value: + from: + type: user + id: 123_doesnt_exist + body: Hello there + "/conversations/{id}": + get: + summary: Retrieve a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + - name: display_as + in: query + required: false + description: Set to plaintext to retrieve conversation messages in plain text. + example: plaintext + schema: + type: string + tags: + - Conversations + operationId: retrieveConversation + description: |2 + + You can fetch the details of a single conversation. + + This will return a single Conversation model with all its conversation parts. + + {% admonition type="warning" name="Hard limit of 500 parts" %} + The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + {% /admonition %} + + For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). + responses: + '200': + description: conversation found + content: + application/json: + examples: + conversation found: + value: + type: conversation + id: '367' + created_at: 1719492825 + updated_at: 1719492825 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918255' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267553' + name: Ciaran153 Lee + email: admin153@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60d88a68186f43bafde1 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: [] + total_count: 0 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 978c1e65-1eba-4995-9acb-ff8f33b283e3 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b1f6adfd-f7da-4880-8d11-d842235126ae + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: c7b0a10f-d482-4352-8d7b-1ad26b902473 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + - name: display_as + in: query + required: false + description: Set to plaintext to retrieve conversation messages in plain text. + example: plaintext + schema: + type: string + tags: + - Conversations + operationId: updateConversation + description: |2+ + + You can update an existing conversation. + + {% admonition type="info" name="Replying and other actions" %} + If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + {% /admonition %} + + responses: + '200': + description: conversation found + content: + application/json: + examples: + conversation found: + value: + type: conversation + id: '371' + created_at: 1719492832 + updated_at: 1719492834 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918259' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267561' + name: Ciaran157 Lee + email: admin157@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60e08a68186f43bafde5 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: + issue_type: Billing + priority: High + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '96' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + assigned_to: + author: + id: '991267562' + type: bot + name: Operator + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + - type: conversation_part + id: '97' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + assigned_to: + author: + id: '991267562' + type: bot + name: Operator + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + total_count: 2 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: e4c692dd-cccd-46bf-834a-cda7a3a9029c + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 58e6b9ee-4a28-4597-9c20-faf34b6894dc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: cf6fb162-88c9-45ec-9f97-c3fcad93b7c1 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_conversation_request" + examples: + conversation_found: + summary: conversation found + value: + read: true + custom_attributes: + issue_type: Billing + priority: High + not_found: + summary: Not found + value: + read: true + custom_attributes: + issue_type: Billing + priority: High + "/conversations/search": + post: + summary: Search conversations + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: searchConversations + description: | + You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + + To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. + + This will accept a query object in the body which will define your filters in order to search for conversations. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiple's there can be: + - There's a limit of max 2 nested filters + - There's a limit of max 15 filters for each AND or OR group + + ### Accepted Fields + + Most keys listed as part of the The conversation model is searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + + | Field | Type | + | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + | id | String | + | created_at | Date (UNIX timestamp) | + | updated_at | Date (UNIX timestamp) | + | source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. | + | source.id | String | + | source.delivered_as | String | + | source.subject | String | + | source.body | String | + | source.author.id | String | + | source.author.type | String | + | source.author.name | String | + | source.author.email | String | + | source.url | String | + | contact_ids | String | + | teammate_ids | String | + | admin_assignee_id | String | + | team_assignee_id | String | + | channel_initiated | String | + | open | Boolean | + | read | Boolean | + | state | String | + | waiting_since | Date (UNIX timestamp) | + | snoozed_until | Date (UNIX timestamp) | + | tag_ids | String | + | priority | String | + | statistics.time_to_assignment | Integer | + | statistics.time_to_admin_reply | Integer | + | statistics.time_to_first_close | Integer | + | statistics.time_to_last_close | Integer | + | statistics.median_time_to_reply | Integer | + | statistics.first_contact_reply_at | Date (UNIX timestamp) | + | statistics.first_assignment_at | Date (UNIX timestamp) | + | statistics.first_admin_reply_at | Date (UNIX timestamp) | + | statistics.first_close_at | Date (UNIX timestamp) | + | statistics.last_assignment_at | Date (UNIX timestamp) | + | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + | statistics.last_contact_reply_at | Date (UNIX timestamp) | + | statistics.last_admin_reply_at | Date (UNIX timestamp) | + | statistics.last_close_at | Date (UNIX timestamp) | + | statistics.last_closed_by_id | String | + | statistics.count_reopens | Integer | + | statistics.count_assignments | Integer | + | statistics.count_conversation_parts | Integer | + | conversation_rating.requested_at | Date (UNIX timestamp) | + | conversation_rating.replied_at | Date (UNIX timestamp) | + | conversation_rating.score | Integer | + | conversation_rating.remark | String | + | conversation_rating.contact_id | String | + | conversation_rating.admin_d | String | + | ai_agent_participated | Boolean | + | ai_agent.resolution_state | String | + | ai_agent.last_answer_type | String | + | ai_agent.rating | Integer | + | ai_agent.rating_remark | String | + | ai_agent.source_type | String | + | ai_agent.source_title | String | + + ### Accepted Operators + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :----------------------------- | :----------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In Shortcut for `OR` queries Values most be in Array | + | NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | + | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: conversation.list + pages: + type: pages + page: 1 + per_page: 5 + total_pages: 1 + total_count: 1 + conversations: + - type: conversation + id: '378' + created_at: 1719492843 + updated_at: 1719492843 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918266' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267591' + name: Ciaran180 Lee + email: admin180@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60ea8a68186f43bafdec + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + schema: + "$ref": "#/components/schemas/conversation_list" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: created_at + operator: ">" + value: '1306054154' + pagination: + per_page: 5 + "/conversations/{id}/reply": + post: + summary: Reply to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The Intercom provisioned identifier for the conversation or the + string "last" to reply to the last part of the conversation + example: 123 or "last" + schema: + type: string + tags: + - Conversations + operationId: replyConversation + description: You can reply to a conversation with a message from an admin or + on behalf of a contact, or with a note for admins. + responses: + '200': + description: User last conversation reply + content: + application/json: + examples: + User reply: + value: + type: conversation + id: '387' + created_at: 1719492849 + updated_at: 1719492850 + waiting_since: 1719492850 + snoozed_until: + source: + type: conversation + id: '403918269' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267594' + name: Ciaran182 Lee + email: admin182@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f18a68186f43bafdf4 + external_id: '70' + first_contact_reply: + created_at: 1719492850 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '99' + part_type: open + body: "

Thanks again :)

" + created_at: 1719492850 + updated_at: 1719492850 + notified_at: 1719492850 + assigned_to: + author: + id: 667d60f18a68186f43bafdf4 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Admin note reply: + value: + type: conversation + id: '388' + created_at: 1719492852 + updated_at: 1719492853 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918270' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267596' + name: Ciaran183 Lee + email: admin183@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f38a68186f43bafdf5 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '100' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
    • +
  • Tea
    • +
  • Milk
    • +
+

An Ordered HTML List

+
    +
  1. Coffee
    2. +
  2. Tea
    3. +
  3. Milk
    4. +
+ created_at: 1719492853 + updated_at: 1719492853 + notified_at: 1719492853 + assigned_to: + author: + id: '991267596' + type: admin + name: Ciaran183 Lee + email: admin183@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + User last conversation reply: + value: + type: conversation + id: '390' + created_at: 1719492855 + updated_at: 1719492856 + waiting_since: 1719492856 + snoozed_until: + source: + type: conversation + id: '403918272' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267600' + name: Ciaran185 Lee + email: admin185@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f78a68186f43bafdf7 + external_id: '70' + first_contact_reply: + created_at: 1719492856 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '101' + part_type: open + body: "

Thanks again :)

" + created_at: 1719492856 + updated_at: 1719492856 + notified_at: 1719492856 + assigned_to: + author: + id: 667d60f78a68186f43bafdf7 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 8193a639-aba8-4b0e-9fdd-ee48807e3ee7 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7435aa28-13bd-40b1-ba99-66009e92a1ba + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 9fe5809c-cf0b-4a0f-af80-9913d3beb1eb + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/reply_conversation_request" + examples: + user_reply: + summary: User reply + value: + message_type: comment + type: user + intercom_user_id: 667d60f18a68186f43bafdf4 + body: Thanks again :) + admin_note_reply: + summary: Admin note reply + value: + message_type: note + type: admin + admin_id: 991267596 + body: "

An Unordered HTML List

  • Coffee
    • + \
  • Tea
  • Milk

An Ordered HTML List

+ \
  1. Coffee
  2. Tea
  3. Milk
+ \ " + user_last_conversation_reply: + summary: User last conversation reply + value: + message_type: comment + type: user + intercom_user_id: 667d60f78a68186f43bafdf7 + body: Thanks again :) + not_found: + summary: Not found + value: + message_type: comment + type: user + intercom_user_id: 667d60f98a68186f43bafdf8 + body: Thanks again :) + "/conversations/{id}/parts": + post: + summary: Manage a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: manageConversation + description: | + For managing conversations you can: + - Close a conversation + - Snooze a conversation to reopen on a future date + - Open a conversation which is `snoozed` or `closed` + - Assign a conversation to an admin and/or team. + responses: + '200': + description: Assign a conversation + content: + application/json: + examples: + Close a conversation: + value: + type: conversation + id: '394' + created_at: 1719492862 + updated_at: 1719492862 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918276' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267608' + name: Ciaran189 Lee + email: admin189@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60fd8a68186f43bafdfb + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '102' + part_type: close + body: "

Goodbye :)

" + created_at: 1719492862 + updated_at: 1719492862 + notified_at: 1719492862 + assigned_to: + author: + id: '991267608' + type: admin + name: Ciaran189 Lee + email: admin189@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Snooze a conversation: + value: + type: conversation + id: '395' + created_at: 1719492864 + updated_at: 1719492864 + waiting_since: + snoozed_until: 1719496464 + source: + type: conversation + id: '403918277' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267610' + name: Ciaran190 Lee + email: admin190@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60ff8a68186f43bafdfc + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: true + state: snoozed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '103' + part_type: snoozed + body: + created_at: 1719492864 + updated_at: 1719492864 + notified_at: 1719492864 + assigned_to: + author: + id: '991267610' + type: admin + name: Ciaran190 Lee + email: admin190@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Open a conversation: + value: + type: conversation + id: '400' + created_at: 1719492863 + updated_at: 1719492873 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918278' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267612' + name: Ciaran191 Lee + email: admin191@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61038a68186f43bafe01 + external_id: '74' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: '' + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '105' + part_type: open + body: + created_at: 1719492873 + updated_at: 1719492873 + notified_at: 1719492873 + assigned_to: + author: + id: '991267612' + type: admin + name: Ciaran191 Lee + email: admin191@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Assign a conversation: + value: + type: conversation + id: '405' + created_at: 1719492874 + updated_at: 1719492875 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918281' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267615' + name: Ciaran193 Lee + email: admin193@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d610a8a68186f43bafe05 + external_id: '70' + first_contact_reply: + admin_assignee_id: 991267615 + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '106' + part_type: assign_and_reopen + body: + created_at: 1719492875 + updated_at: 1719492875 + notified_at: 1719492875 + assigned_to: + type: admin + id: '991267615' + author: + id: '991267615' + type: admin + name: Ciaran193 Lee + email: admin193@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 1bfc14e1-07ef-4999-9448-f029b112cf1b + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ae0581d2-199e-437c-bf51-1eb9fe2e12fc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: a7e069bb-f013-45bc-8e0a-f58c3de4e034 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/close_conversation_request" + - "$ref": "#/components/schemas/snooze_conversation_request" + - "$ref": "#/components/schemas/open_conversation_request" + - "$ref": "#/components/schemas/assign_conversation_request" + examples: + close_a_conversation: + summary: Close a conversation + value: + message_type: close + type: admin + admin_id: 991267608 + body: Goodbye :) + snooze_a_conversation: + summary: Snooze a conversation + value: + message_type: snoozed + admin_id: 991267610 + snoozed_until: 1719496464 + open_a_conversation: + summary: Open a conversation + value: + message_type: open + admin_id: 991267612 + assign_a_conversation: + summary: Assign a conversation + value: + message_type: assignment + type: admin + admin_id: 991267615 + assignee_id: 991267615 + not_found: + summary: Not found + value: + message_type: close + type: admin + admin_id: 991267617 + body: Goodbye :) + "/conversations/{id}/run_assignment_rules": + post: + summary: Run Assignment Rules on a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: autoAssignConversation + description: | + You can let a conversation be automatically assigned following assignment rules. + {% admonition type="attention" name="When using workflows" %} + It is not possible to use this endpoint with Workflows. + {% /admonition %} + responses: + '200': + description: Assign a conversation using assignment rules + content: + application/json: + examples: + Assign a conversation using assignment rules: + value: + type: conversation + id: '409' + created_at: 1719492880 + updated_at: 1719492881 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918285' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267623' + name: Ciaran197 Lee + email: admin197@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61108a68186f43bafe09 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '107' + part_type: default_assignment + body: + created_at: 1719492881 + updated_at: 1719492881 + notified_at: 1719492881 + assigned_to: + type: nobody_admin + id: + author: + id: '991267624' + type: bot + name: Operator + email: operator+this_is_an_id364_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 9d88a5a7-6df9-42ff-b324-2387db7be984 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 8aeac960-c7fb-41f7-8cc9-cd3d62f6ff92 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: '037980c4-84cb-4d3a-ad64-66e4e563a275' + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + "/conversations/{id}/customers": + post: + summary: Attach a contact to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: attachContactToConversation + description: |+ + You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + + {% admonition type="attention" name="Contacts without an email" %} + If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. + {% /admonition %} + + responses: + '200': + description: Attach a contact to a conversation + content: + application/json: + examples: + Attach a contact to a conversation: + value: + customers: + - type: user + id: 667d61168a68186f43bafe0d + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 1fd64942-5bf0-4a51-a6cb-db4a778bb1f4 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4f00c4c6-a8f7-436e-bf95-d1adfa315906 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 3d1c3371-6ba4-4d5a-9368-ac983292136d + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/attach_contact_to_conversation_request" + examples: + attach_a_contact_to_a_conversation: + summary: Attach a contact to a conversation + value: + admin_id: 991267631 + customer: + intercom_user_id: 667d61168a68186f43bafe0d + not_found: + summary: Not found + value: + admin_id: 991267633 + customer: + intercom_user_id: 667d61188a68186f43bafe0e + "/conversations/{conversation_id}/customers/{contact_id}": + delete: + summary: Detach a contact from a group conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + - name: contact_id + in: path + required: true + description: The identifier for the contact as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: detachContactFromConversation + description: |+ + You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + + {% admonition type="attention" name="Contacts without an email" %} + If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. + {% /admonition %} + + responses: + '200': + description: Detach a contact from a group conversation + content: + application/json: + examples: + Detach a contact from a group conversation: + value: + customers: + - type: user + id: 667d61228a68186f43bafe19 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Contact not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: 579f0f7a-d773-41d6-9d36-8cc0b3fbcc41 + errors: + - code: not_found + message: Resource Not Found + Contact not found: + value: + type: error.list + request_id: 44531412-2973-4b92-b14d-80abac5c1b4d + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '422': + description: Last customer + content: + application/json: + examples: + Last customer: + value: + type: error.list + request_id: 35a0444f-8a1e-40e9-a5fc-dd1ae2df8bc6 + errors: + - code: parameter_invalid + message: Removing the last customer is not allowed + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d35f1b37-765c-4afe-8738-81c0560710a6 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: d30f18d4-2e0a-4528-a66b-4590b733713c + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/detach_contact_from_conversation_request" + examples: + detach_a_contact_from_a_group_conversation: + summary: Detach a contact from a group conversation + value: + admin_id: 991267639 + customer: + intercom_user_id: 667d611c8a68186f43bafe11 + conversation_not_found: + summary: Conversation not found + value: + admin_id: 991267642 + customer: + intercom_user_id: 667d61248a68186f43bafe1a + contact_not_found: + summary: Contact not found + value: + admin_id: 991267645 + customer: + intercom_user_id: 667d612b8a68186f43bafe22 + last_customer: + summary: Last customer + value: + admin_id: 991267648 + customer: + intercom_user_id: 667d61338a68186f43bafe2a + "/conversations/redact": + post: + summary: Redact a conversation part + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: redactConversation + description: |+ + You can redact a conversation part or the source message of a conversation (as seen in the source object). + + {% admonition type="info" name="Redacting parts and messages" %} + If you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met. + {% /admonition %} + + responses: + '200': + description: Redact a conversation part + content: + application/json: + examples: + Redact a conversation part: + value: + type: conversation + id: '471' + created_at: 1719492938 + updated_at: 1719492940 + waiting_since: 1719492939 + snoozed_until: + source: + type: conversation + id: '403918311' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267657' + name: Ciaran217 Lee + email: admin217@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d614a8a68186f43bafe42 + external_id: '70' + first_contact_reply: + created_at: 1719492939 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '115' + part_type: open + body: "

This message was deleted

" + created_at: 1719492939 + updated_at: 1719492940 + notified_at: 1719492939 + assigned_to: + author: + id: 667d614a8a68186f43bafe42 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: true + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 0c016386-49f4-431f-92dc-7e739cbf98e1 + errors: + - code: conversation_part_or_message_not_found + message: Conversation part or message not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 1b830d07-a249-4ff8-a7bf-41bf83fd53b2 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/redact_conversation_request" + examples: + redact_a_conversation_part: + summary: Redact a conversation part + value: + type: conversation_part + conversation_id: 471 + conversation_part_id: 115 + not_found: + summary: Not found + value: + type: conversation_part + conversation_id: really_123_doesnt_exist + conversation_part_id: really_123_doesnt_exist + "/conversations/{id}/convert": + post: + summary: Convert a conversation to a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + tags: + - Conversations + description: You can convert a conversation to a ticket. + operationId: convertConversationToTicket + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: ticket + id: '474' + ticket_id: '37' + ticket_attributes: {} + ticket_state: submitted + ticket_type: + type: ticket_type + id: '79' + name: my-ticket-type-1 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id404_that_should_be_at_least_ + archived: false + created_at: 1719492947 + updated_at: 1719492947 + is_internal: false + ticket_type_attributes: + type: list + data: [] + category: Customer + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61518a68186f43bafe45 + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719492945 + updated_at: 1719492947 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '117' + part_type: comment + body: "

Comment for message

" + created_at: 1719492945 + updated_at: 1719492945 + author: + id: 667d61518a68186f43bafe45 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + redacted: false + - type: ticket_part + id: '118' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719492947 + updated_at: 1719492947 + author: + id: '991267667' + type: bot + name: Operator + email: operator+this_is_an_id404_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 2 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Customer + is_shared: true + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket" + '400': + description: Bad request + content: + application/json: + examples: + Bad request: + value: + type: error.list + request_id: 74656c1a-0a17-4c80-a7b9-66fa45c6d71b + errors: + - code: parameter_invalid + message: Ticket type is not a customer ticket type + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/convert_conversation_to_ticket_request" + examples: + successful: + summary: successful + value: + ticket_type_id: '79' + bad_request: + summary: Bad request + value: + ticket_type_id: '80' + "/data_attributes": + get: + summary: List all data attributes + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: model + in: query + required: false + description: Specify the data attribute model to return. + schema: + type: string + enum: + - contact + - company + - conversation + example: company + - name: include_archived + in: query + required: false + description: Include archived attributes in the list. By default we return + only non archived data attributes. + example: false + schema: + type: boolean + tags: + - Data Attributes + operationId: lisDataAttributes + description: You can fetch a list of all data attributes belonging to a workspace + for contacts, companies or conversations. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: list + data: + - type: data_attribute + name: name + full_name: name + label: Company name + description: The name of a company + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: company_id + full_name: company_id + label: Company ID + description: A number identifying a company + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: last_request_at + full_name: last_request_at + label: Company last seen + description: The last day anyone from a company visited your + site or app + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: remote_created_at + full_name: remote_created_at + label: Company created at + description: The day a company was added to Intercom + data_type: date + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: user_count + full_name: user_count + label: People + description: The number of people in a company + data_type: integer + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: session_count + full_name: session_count + label: Company web sessions + description: All visits from anyone in a company to your product's + site or app + data_type: integer + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: name + full_name: plan.name + label: Plan + description: A specific plan or level within your product that + companies have signed up to + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: monthly_spend + full_name: monthly_spend + label: Monthly Spend + description: The monthly revenue you receive from a company + data_type: float + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: size + full_name: size + label: Company size + description: The number of people employed in this company, + expressed as a single number + data_type: integer + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: industry + full_name: industry + label: Company industry + description: The category or domain this company belongs to + e.g. 'ecommerce' or 'SaaS' + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: website + full_name: website + label: Company website + description: The web address for the company's primary marketing + site + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - id: 34 + type: data_attribute + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: One ring to rule them all, one ring to find them, + One ring to bring them all and in the darkness bind them. + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: true + archived: false + admin_id: '991267684' + created_at: 1719492954 + updated_at: 1719492954 + model: company + - type: data_attribute + name: id + full_name: id + label: ID + description: The Intercom defined id representing the company + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: created_at + full_name: created_at + label: Created at + description: The time the company was added to Intercom + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: updated_at + full_name: updated_at + label: Updated at + description: The last time the company was updated + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: id + full_name: plan.id + label: Plan ID + description: The Intercom defined id representing the plan + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: app_id + full_name: app_id + label: App ID + description: The Intercom defined id representing the app + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + schema: + "$ref": "#/components/schemas/data_attribute_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6e76e914-a34d-4125-8310-62fdfc4e651e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a data attribute + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Attributes + operationId: createDataAttribute + description: You can create a data attributes for a `contact` or a `company`. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 37 + type: data_attribute + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + data_type: string + api_writable: true + ui_writable: false + messenger_writable: false + custom: true + archived: false + admin_id: '991267686' + created_at: 1719492955 + updated_at: 1719492955 + model: company + schema: + "$ref": "#/components/schemas/data_attribute" + '400': + description: Too few options for list + content: + application/json: + examples: + Same name already exists: + value: + type: error.list + request_id: bcd93885-3f01-4b92-9918-c96a3f4492e8 + errors: + - code: parameter_invalid + message: You already have 'The One Ring' in your company data. + To save this as new people data, use a different name. + Invalid name: + value: + type: error.list + request_id: 7420c5e3-22c3-46be-8a23-72fef8f8ec0e + errors: + - code: parameter_invalid + message: Your name for this attribute must only contain alphanumeric + characters, currency symbols, and hyphens + Attribute already exists: + value: + type: error.list + request_id: c844551a-05d3-4f8c-931a-32e96bf3a508 + errors: + - code: parameter_invalid + message: You already have 'The One Ring' in your company data. + To save this as new company data, use a different name. + Invalid Data Type: + value: + type: error.list + request_id: b8c58b81-8445-473d-8fe3-7880c04f9547 + errors: + - code: parameter_invalid + message: Data Type isn't an option + Too few options for list: + value: + type: error.list + request_id: 119e3822-3a45-48cf-b5ab-037f27a948c8 + errors: + - code: parameter_invalid + message: The Data Attribute model field must be either contact + or company + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b74d8980-6e99-44db-a3d8-2a65a63fe590 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_attribute_request" + examples: + successful: + summary: Successful + value: + name: Mithril Shirt + model: company + data_type: string + same_name_already_exists: + summary: Same name already exists + value: + name: The One Ring + model: contact + data_type: integer + invalid_name: + summary: Invalid name + value: + name: "!nv@l!d n@me" + model: company + data_type: string + attribute_already_exists: + summary: Attribute already exists + value: + name: The One Ring + model: company + data_type: string + invalid_data_type: + summary: Invalid Data Type + value: + name: The Second Ring + model: company + data_type: mithril + too_few_options_for_list: + summary: Too few options for list + value: + description: Just a plain old ring + options: + - value: 1-10 + archived: false + "/data_attributes/{id}": + put: + summary: Update a data attribute + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The data attribute id + example: 1 + schema: + type: integer + tags: + - Data Attributes + operationId: updateDataAttribute + description: "\nYou can update a data attribute.\n\n> \U0001F6A7 Updating the + data type is not possible\n>\n> It is currently a dangerous action to execute + changing a data attribute's type via the API. You will need to update the + type via the UI instead.\n" + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 44 + type: data_attribute + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + ui_writable: false + messenger_writable: true + custom: true + archived: false + admin_id: '991267693' + created_at: 1719492958 + updated_at: 1719492959 + model: company + schema: + "$ref": "#/components/schemas/data_attribute" + '400': + description: Too few options in list + content: + application/json: + examples: + Too few options in list: + value: + type: error.list + request_id: 6615f20c-01df-443c-9ea1-c954ba6b09d6 + errors: + - code: parameter_invalid + message: Options isn't an array + schema: + "$ref": "#/components/schemas/error" + '404': + description: Attribute Not Found + content: + application/json: + examples: + Attribute Not Found: + value: + type: error.list + request_id: 2680a225-4f79-4098-8438-8db993c639fe + errors: + - code: field_not_found + message: We couldn't find that data attribute to update + schema: + "$ref": "#/components/schemas/error" + '422': + description: Has Dependant Object + content: + application/json: + examples: + Has Dependant Object: + value: + type: error.list + request_id: fbc508f1-9cbf-4134-90ea-baa1065760d2 + errors: + - code: data_invalid + message: The Data Attribute you are trying to archive has a + dependant object + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0cfc97c0-32be-4e68-aef2-f5744e4e85f7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_data_attribute_request" + examples: + successful: + summary: Successful + value: + description: Just a plain old ring + options: + - value: 1-10 + - value: 11-20 + archived: false + too_few_options_in_list: + summary: Too few options in list + value: + description: Too few options + options: + value: 1-10 + archived: false + attribute_not_found: + summary: Attribute Not Found + value: + description: Just a plain old ring + options: + - value: 1-10 + - value: 11-20 + archived: false + has_dependant_object: + summary: Has Dependant Object + value: + description: Trying to archieve + archived: true + "/events": + post: + summary: Submit a data event + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Events + operationId: createDataEvent + description: |2+ + + You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + + When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + + With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + + **NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + + | Type | Description | Example | + | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + | String | The value is a JSON String | `"source":"desktop"` | + | Number | The value is a JSON Number | `"load": 3.67` | + | Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | + | Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | + | Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | + | Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + + **Lead Events** + + When submitting events for Leads, you will need to specify the Lead's `id`. + + **Metadata behaviour** + + - We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. + - It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. + - There might be up to 24 hrs delay when you send a new metadata for an existing event. + + **Event de-duplication** + + The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + + Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + + ### HTTP API Responses + + - Successful responses to submitted events return `202 Accepted` with an empty body. + - Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. + - Events sent about users that cannot be found will return a `404 Not Found`. + - Event lists containing duplicate events will have those duplicates ignored. + - Server errors will return a `500` response code and may contain an error message in the body. + + responses: + '202': + description: successful + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c6b3dcbd-33be-4a80-abb4-c5b3315250d0 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_event_request" + get: + summary: List all data events + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - in: query + name: filter + required: true + style: form + explode: true + schema: + type: object + oneOf: + - title: user_id query parameter + properties: + user_id: + type: string + required: + - user_id + additionalProperties: false + - title: intercom_user_id query parameter + properties: + intercom_user_id: + type: string + required: + - intercom_user_id + additionalProperties: false + - title: email query parameter + properties: + email: + type: string + required: + - email + additionalProperties: false + - name: type + in: query + required: true + description: The value must be user + schema: + type: string + - name: summary + in: query + required: false + description: summary flag + schema: + type: boolean + tags: + - Data Events + operationId: lisDataEvents + description: "\n> \U0001F6A7\n>\n> Please note that you can only 'list' events + that are less than 90 days old. Event counts and summaries will still include + your events older than 90 days but you cannot 'list' these events individually + if they are older than 90 days\n\nThe events belonging to a customer can be + listed by sending a GET request to `https://api.intercom.io/events` with a + user or lead identifier along with a `type` parameter. The identifier parameter + can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter + value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- + `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` + (this call can be used to list leads)\n\nThe `email` parameter value should + be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou + can optionally define the result page size as well with the `per_page` parameter.\n" + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: event.summary + events: [] + pages: + next: http://api.intercom.test/events?next page + email: user26@email.com + intercom_user_id: 667d61648a68186f43bafe4b + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + schema: + "$ref": "#/components/schemas/data_event_summary" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: bfdcc6de-2dcb-4725-acc7-232c10838586 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/events/summaries": + post: + summary: Create event summaries + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Events + operationId: dataEventSummaries + description: "Create event summaries for a user. Event summaries are used to + track the number of times an event has occurred, the first time it occurred + and the last time it occurred.\n\n" + responses: + '200': + description: successful + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 110801d1-2f7b-436f-8f03-2245545a1432 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_event_summaries_request" + "/export/content/data": + post: + summary: Create content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Export + operationId: createDataExport + description: "To create your export job, you need to send a `POST` request to + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 + Limit of one active job\n>\n> You can only have one active job per workspace. + You will receive a HTTP status code of 429 with the message Exceeded rate + limit of 1 pending message data export jobs if you attempt to create a second + concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that + the timeframe only includes messages sent during the time period and not messages + that were only updated during this period. For example, if a message was updated + yesterday but sent two days ago, you would need to set the created_at_after + date before the message was sent to include that in your retrieval job.\n\n>\U0001F4D8 + Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 + will get all data for those days including those specified - e.g. 2018-06-01 + 00:00:00 until 2018-06-30 23:59:99.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: bxe9awlish03jkq8 + status: pending + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_exports_request" + examples: + successful: + summary: successful + value: + created_at_after: 1719474967 + created_at_before: 1719492967 + "/export/content/data/{job_identifier}": + get: + summary: Show content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: getDataExport + description: "You can view the status of your job by sending a `GET` request + to the URL\n`https://api.intercom.io/export/content/data/{job_identifier}` + - the `{job_identifier}` is the value returned in the response when you first + created the export job. More on it can be seen in the Export Job Model.\n\n> + \U0001F6A7 Jobs expire after two days\n> All jobs that have completed processing + (and are thus available to download from the provided URL) will have an expiry + limit of two days from when the export ob completed. After this, the data + will no longer be available.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: b1ppo8h93fj386fk + status: pending + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + "/export/cancel/{job_identifier}": + post: + summary: Cancel content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: cancelDataExport + description: You can cancel your job + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: pwrbmmimhakvlfsh + status: canceled + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + "/download/content/data/{job_identifier}": + get: + summary: Download content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: downloadDataExport + description: "When a job has a status of complete, and thus a filled download_url, + you can download your data by hitting that provided URL, formatted like so: + https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message + data will be streamed continuously back down to you in a gzipped CSV format.\n\n> + \U0001F4D8 Octet header required\n>\n> You will have to specify the header + Accept: `application/octet-stream` when hitting this endpoint.\n" + responses: + '200': + description: successful + "/messages": + post: + summary: Create a message + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Messages + operationId: createMessage + description: "You can create a message that has been initiated by an admin. + The conversation can be either an in-app message or an email.\n\n> \U0001F6A7 + Sending for visitors\n>\n> There can be a short delay between when a contact + is created and when a contact becomes available to be messaged through the + API. A 404 Not Found error will be returned in this case.\n\nThis will return + the Message model that has been created.\n\n> \U0001F6A7 Retrieving Associated + Conversations\n>\n> As this is a message, there will be no conversation present + until the contact responds. Once they do, you will have to search for a contact's + conversations with the id of the message.\n" + responses: + '200': + description: admin message created + content: + application/json: + examples: + user message created: + value: + type: user_message + id: '403918316' + created_at: 1719492969 + body: heyy + message_type: inapp + conversation_id: '476' + lead message created: + value: + type: user_message + id: '403918317' + created_at: 1719492971 + body: heyy + message_type: inapp + conversation_id: '477' + admin message created: + value: + type: admin_message + id: '15' + created_at: 1719492972 + subject: heyy + body: heyy + message_type: inapp + owner: + type: admin + id: '991267716' + name: Ciaran269 Lee + email: admin269@email.com + away_mode_enabled: false + away_mode_reassign: false + schema: + "$ref": "#/components/schemas/message" + '400': + description: No body supplied for email message + content: + application/json: + examples: + No body supplied for message: + value: + type: error.list + request_id: 4a52a34f-c7e2-4e70-adf2-ea7f41beb2a1 + errors: + - code: parameter_invalid + message: Body is required + No body supplied for email message: + value: + type: error.list + request_id: 7d54191b-c0fc-4860-a01c-9da6b4e45b7f + errors: + - code: parameter_invalid + message: Body is required + schema: + "$ref": "#/components/schemas/error" + '422': + description: No subject supplied for email message + content: + application/json: + examples: + No subject supplied for email message: + value: + type: error.list + request_id: f54ba906-3255-4fc6-a660-0dab0043ff2b + errors: + - code: parameter_not_found + message: No subject supplied for email message + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ee3ea56e-d0ce-47db-871a-57740e165e5c + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: fab7034a-78bd-4413-a652-8f38783e7bf1 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_message_request" + examples: + user_message_created: + summary: user message created + value: + from: + type: user + id: 667d61698a68186f43bafe50 + body: heyy + referer: https://twitter.com/bob + lead_message_created: + summary: lead message created + value: + from: + type: lead + id: 667d616a8a68186f43bafe51 + body: heyy + referer: https://twitter.com/bob + admin_message_created: + summary: admin message created + value: + from: + type: admin + id: '991267716' + to: + type: user + id: 667d616c8a68186f43bafe52 + message_type: conversation + body: heyy + no_body_supplied_for_message: + summary: No body supplied for message + value: + from: + type: admin + id: '991267718' + to: + type: user + id: 667d616d8a68186f43bafe53 + message_type: inapp + body: + subject: heyy + no_subject_supplied_for_email_message: + summary: No subject supplied for email message + value: + from: + type: admin + id: '991267719' + to: + type: user + user_id: '70' + message_type: email + body: hey there + no_body_supplied_for_email_message: + summary: No body supplied for email message + value: + from: + type: admin + id: '991267720' + to: + type: user + id: 667d616e8a68186f43bafe55 + message_type: email + body: + subject: heyy + "/news/news_items": + get: + summary: List all news items + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: listNewsItems + description: You can fetch a list of all news items + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 10 + total_pages: 1 + type: pages + data: + - id: '29' + type: news-item + workspace_id: this_is_an_id494_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991267725 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1719492976 + updated_at: 1719492976 + newsfeed_assignments: [] + - id: '30' + type: news-item + workspace_id: this_is_an_id494_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991267727 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1719492976 + updated_at: 1719492976 + newsfeed_assignments: [] + total_count: 2 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7b27151d-7bb0-402e-87fe-5780690d9f32 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: createNewsItem + description: You can create a news item + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '33' + type: news-item + workspace_id: this_is_an_id498_that_should_be_at_least_ + title: Halloween is here! + body: "

New costumes in store for this spooky season

" + sender_id: 991267734 + state: live + labels: + - New + - Product + - Update + cover_image_url: + reactions: + - "\U0001F606" + - "\U0001F605" + deliver_silently: true + created_at: 1719492978 + updated_at: 1719492978 + newsfeed_assignments: + - newsfeed_id: 53 + published_at: 1664638214 + schema: + "$ref": "#/components/schemas/news_item" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c36202f1-6bf3-4ea6-9442-192123f506b0 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/news_item_request" + examples: + successful: + summary: successful + value: + title: Halloween is here! + body: "

New costumes in store for this spooky season

" + labels: + - Product + - Update + - New + sender_id: 991267734 + deliver_silently: true + reactions: + - "\U0001F606" + - "\U0001F605" + state: live + newsfeed_assignments: + - newsfeed_id: 53 + published_at: 1664638214 + "/news/news_items/{id}": + get: + summary: Retrieve a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: retrieveNewsItem + description: You can fetch the details of a single news item. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '34' + type: news-item + workspace_id: this_is_an_id502_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991267737 + state: live + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1719492979 + updated_at: 1719492979 + newsfeed_assignments: + - newsfeed_id: 55 + published_at: 1719492980 + schema: + "$ref": "#/components/schemas/news_item" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: 0f4b439e-9b57-4019-886e-15cc08582914 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: cc6af01d-81e3-4a74-8a62-807a3239e1ad + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: updateNewsItem + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '37' + type: news-item + workspace_id: this_is_an_id508_that_should_be_at_least_ + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + sender_id: 991267745 + state: live + labels: [] + cover_image_url: + reactions: + - "\U0001F61D" + - "\U0001F602" + deliver_silently: false + created_at: 1719492982 + updated_at: 1719492982 + newsfeed_assignments: [] + schema: + "$ref": "#/components/schemas/news_item" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: fe6e217d-70bc-4090-b33a-b32ec0e6a391 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f780a591-4aa2-4382-80c4-e0f2d655bf2e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/news_item_request" + examples: + successful: + summary: successful + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + sender_id: 991267745 + reactions: + - "\U0001F61D" + - "\U0001F602" + news_item_not_found: + summary: News Item Not Found + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + sender_id: 991267748 + reactions: + - "\U0001F61D" + - "\U0001F602" + delete: + summary: Delete a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: deleteNewsItem + description: You can delete a single news item. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '40' + object: news-item + deleted: true + schema: + "$ref": "#/components/schemas/deleted_object" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: a191b999-6f71-4676-a8db-1a79ccc4f114 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 521cb8a5-4d47-43dd-94cb-ef54f6f8ce0a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds/{id}/items": + get: + summary: List all live newsfeed items + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news feed item which is given by + Intercom. + example: '123' + schema: + type: string + tags: + - News + operationId: listLiveNewsfeedItems + description: You can fetch a list of all news items that are live on a given + newsfeed + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 20 + total_pages: 0 + type: pages + data: [] + total_count: 0 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: de07bbcf-64ff-4fc8-a7e5-fcbe772b85a5 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds": + get: + summary: List all newsfeeds + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: listNewsfeeds + description: You can fetch a list of all newsfeeds + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 10 + total_pages: 1 + type: pages + data: + - id: '68' + type: newsfeed + name: Visitor Feed + created_at: 1719492987 + updated_at: 1719492987 + - id: '69' + type: newsfeed + name: Visitor Feed + created_at: 1719492987 + updated_at: 1719492987 + total_count: 2 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d00f8d67-1e7c-464b-b0b7-b2409d706076 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds/{id}": + get: + summary: Retrieve a newsfeed + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news feed item which is given by + Intercom. + example: '123' + schema: + type: string + tags: + - News + operationId: retrieveNewsfeed + description: You can fetch the details of a single newsfeed + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '72' + type: newsfeed + name: Visitor Feed + created_at: 1719492988 + updated_at: 1719492988 + schema: + "$ref": "#/components/schemas/newsfeed" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 185ce494-34e2-4cda-85cb-c51ad7281292 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/notes/{id}": + get: + summary: Retrieve a note + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given note + example: 1 + schema: + type: integer + tags: + - Notes + operationId: retrieveNote + description: You can fetch the details of a single note. + responses: + '200': + description: Note found + content: + application/json: + examples: + Note found: + value: + type: note + id: '37' + created_at: 1718801789 + contact: + type: contact + id: 667d617d8a68186f43bafe58 + author: + type: admin + id: '991267764' + name: Ciaran316 Lee + email: admin316@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + schema: + "$ref": "#/components/schemas/note" + '404': + description: Note not found + content: + application/json: + examples: + Note not found: + value: + type: error.list + request_id: 7e37eb4e-9f1e-47fa-a393-8d9b2c20983a + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b29ebc05-ba35-4db8-aac6-d74617769643 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/segments": + get: + summary: List all segments + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: include_count + in: query + required: false + description: It includes the count of contacts that belong to each segment. + example: true + schema: + type: boolean + tags: + - Segments + operationId: listSegments + description: You can fetch a list of all segments. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: segment.list + segments: + - type: segment + id: 667d617f8a68186f43bafe5b + name: John segment + created_at: 1719492991 + updated_at: 1719492991 + person_type: user + - type: segment + id: 667d617f8a68186f43bafe5c + name: Jane segment + created_at: 1719492991 + updated_at: 1719492991 + person_type: user + schema: + "$ref": "#/components/schemas/segment_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d70c184d-852a-4f67-8298-3cf9a327adb3 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/segments/{id}": + get: + summary: Retrieve a segment + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identified of a given segment. + example: '123' + schema: + type: string + tags: + - Segments + operationId: retrieveSegment + description: You can fetch the details of a single segment. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: segment + id: 667d61808a68186f43bafe5f + name: John segment + created_at: 1719492992 + updated_at: 1719492992 + person_type: user + schema: + "$ref": "#/components/schemas/segment" + '404': + description: Segment not found + content: + application/json: + examples: + Segment not found: + value: + type: error.list + request_id: fe79fa5e-c8eb-40a6-be76-d618833c2840 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a9c190ff-16eb-43f9-94fc-7c22da2766af + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/subscription_types": + get: + summary: List subscription types + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Subscription Types + operationId: listSubscriptionTypes + description: You can list all subscription types. A list of subscription type + objects will be returned. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: subscription + id: '137' + state: live + consent_type: opt_out + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - email + schema: + "$ref": "#/components/schemas/subscription_type_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 5fb6b003-d6a6-4641-b71b-c5c468c87448 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/phone_call_redirects": + post: + summary: Create a phone Switch + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Switch + operationId: createPhoneSwitch + description: | + You can use the API to deflect phone calls to the Intercom Messenger. + Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + + If custom attributes are specified, they will be added to the user or lead's custom data attributes. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + url: http://via.intercom.io/msgr/6eb60123-dadb-4881-80fd-4fc2cf272b12 + type: phone_call_redirect + schema: + "$ref": "#/components/schemas/phone_switch" + '400': + description: bad request - invalid number + content: + application/json: + examples: + bad request - exception sending sms: + value: + error_key: sms_failed + message: SMS was not sent due to an unknown error + bad request - invalid number: + value: + error_key: invalid_phone_number + message: Invalid phone number + '422': + description: unprocessable entity + content: + application/json: + examples: + unprocessable entity: + value: + error_key: some_error + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 5da7a3e7-dcb0-4378-8575-0a0e9bae3862 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_phone_switch_request" + examples: + successful: + summary: successful + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + bad_request_-_exception_sending_sms: + summary: bad request - exception sending sms + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + bad_request_-_invalid_number: + summary: bad request - invalid number + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + unprocessable_entity: + summary: unprocessable entity + value: + phone: "+40241100100" + custom_attributes: + issue_type: Billing + priority: High + "/tags": + get: + summary: List all tags + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tags + operationId: listTags + description: "You can fetch a list of all tags for a given workspace.\n\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: tag + id: '115' + name: Manual tag 1 + schema: + "$ref": "#/components/schemas/tag_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c83a3efe-433a-4555-a5e2-e393588be29f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create or update a tag, Tag or untag companies, Tag contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tags + operationId: createTag + description: | + You can use this endpoint to perform the following operations: + + **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below. + + **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below. + + **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically. + + **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below. + + **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below. + + Each operation will return a tag object. + responses: + '200': + description: Action successful + content: + application/json: + examples: + Action successful: + value: + type: tag + id: '118' + name: test + schema: + "$ref": "#/components/schemas/tag" + '400': + description: Invalid parameters + content: + application/json: + examples: + Invalid parameters: + value: + type: error.list + request_id: a7afe3c5-be52-4b69-9268-50ef1d917a1b + errors: + - code: parameter_invalid + message: invalid tag parameters + schema: + "$ref": "#/components/schemas/error" + '404': + description: User not found + content: + application/json: + examples: + Company not found: + value: + type: error.list + request_id: f0f84d9b-3c51-4904-9c21-34faba76ebf5 + errors: + - code: company_not_found + message: Company Not Found + User not found: + value: + type: error.list + request_id: 786848c6-5b9f-4e9b-aa78-2bdec45a09f5 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3609e8b1-a6aa-4c57-a994-3d95743f20a2 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/create_or_update_tag_request" + - "$ref": "#/components/schemas/tag_company_request" + - "$ref": "#/components/schemas/untag_company_request" + - "$ref": "#/components/schemas/tag_multiple_users_request" + examples: + action_successful: + summary: Action successful + value: + name: test + invalid_parameters: + summary: Invalid parameters + value: + test: invalid + company_not_found: + summary: Company not found + value: + name: test + companies: + - company_id: '123' + user_not_found: + summary: User not found + value: + name: test + users: + - id: '123' + "/tags/{id}": + get: + summary: Find a specific tag + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string + tags: + - Tags + operationId: findTag + description: | + You can fetch the details of tags that are on the workspace by their id. + This will return a tag object. + responses: + '200': + description: Tag found + content: + application/json: + examples: + Tag found: + value: + type: tag + id: '126' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Tag not found: + value: + type: error.list + request_id: 20b89fb6-f224-4f81-98ca-4cb4b36df959 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 76a1d79d-3f0d-49bb-8d15-38d1ae6df738 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete tag + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string + tags: + - Tags + operationId: deleteTag + description: You can delete the details of tags that are on the workspace by + passing in the id. + responses: + '200': + description: Successful + '404': + description: Resource not found + content: + application/json: + examples: + Resource not found: + value: + type: error.list + request_id: 111586bb-ad78-43b9-b0a0-bf864d9a3744 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '400': + description: Tag has dependent objects + content: + application/json: + examples: + Tag has dependent objects: + value: + type: error.list + request_id: 41086388-9b3b-4e07-9633-502b9b10c926 + errors: + - code: tag_has_dependent_objects + message: 'Unable to delete Tag with dependent objects. Segments: + Seg 1.' + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3dcedf54-ed30-4337-8992-94e36900e695 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/teams": + get: + summary: List all teams + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Teams + operationId: listTeams + description: This will return a list of team objects for the App. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: team.list + teams: [] + schema: + "$ref": "#/components/schemas/team_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 006b2c8f-9a29-463e-be69-ad213576aee6 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/teams/{id}": + get: + summary: Retrieve a team + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given team. + example: '123' + schema: + type: string + tags: + - Teams + operationId: retrieveTeam + description: You can fetch the details of a single team, containing an array + of admins that belong to this team. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: team + id: '991267802' + name: team 1 + admin_ids: [] + schema: + "$ref": "#/components/schemas/team" + '404': + description: Team not found + content: + application/json: + examples: + Team not found: + value: + type: error.list + request_id: 4745dfce-7275-4864-abfd-44e0d84bf52a + errors: + - code: team_not_found + message: Team not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 110ad8e4-99ed-461a-bd93-92a5cdbaa6b2 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/ticket_types/{ticket_type_id}/attributes": + post: + summary: Create a new attribute for a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_type_id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Type Attributes + description: You can create a new attribute for a ticket type. + operationId: createTicketTypeAttribute + responses: + '200': + description: Ticket Type Attribute created + content: + application/json: + examples: + Ticket Type Attribute created: + value: + type: ticket_type_attribute + id: '210' + workspace_id: this_is_an_id600_that_should_be_at_least_ + name: Attribute Title + description: Attribute Description + data_type: string + input_options: + multiline: false + order: 2 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: false + ticket_type_id: 81 + archived: false + created_at: 1719493013 + updated_at: 1719493013 + schema: + "$ref": "#/components/schemas/ticket_type_attribute" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3bc672fa-e051-4ede-b6e9-79f518231ba9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_type_attribute_request" + examples: + ticket_type_attribute_created: + summary: Ticket Type Attribute created + value: + name: Attribute Title + description: Attribute Description + data_type: string + required_to_create: false + "/ticket_types/{ticket_type_id}/attributes/{id}": + put: + summary: Update an existing attribute for a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_type_id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + - name: id + in: path + required: true + description: The unique identifier for the ticket type attribute which is + given by Intercom. + schema: + type: string + tags: + - Ticket Type Attributes + description: You can update an existing attribute for a ticket type. + operationId: updateTicketTypeAttribute + responses: + '200': + description: Ticket Type Attribute updated + content: + application/json: + examples: + Ticket Type Attribute updated: + value: + type: ticket_type_attribute + id: '215' + workspace_id: this_is_an_id604_that_should_be_at_least_ + name: name + description: New Attribute Description + data_type: string + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 83 + archived: false + created_at: 1719493013 + updated_at: 1719493014 + schema: + "$ref": "#/components/schemas/ticket_type_attribute" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6e45414c-e627-4769-bdbd-d51f2c19e1e9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_type_attribute_request" + examples: + ticket_type_attribute_updated: + summary: Ticket Type Attribute updated + value: + description: New Attribute Description + "/ticket_types": + get: + summary: List all ticket types + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Ticket Types + operationId: listTicketTypes + description: You can get a list of all ticket types for a workspace. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: ticket_type + id: '85' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id608_that_should_be_at_least_ + archived: false + created_at: 1719493014 + updated_at: 1719493014 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '218' + workspace_id: this_is_an_id608_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 85 + archived: false + created_at: 1719493014 + updated_at: 1719493014 + - type: ticket_type_attribute + id: '220' + workspace_id: this_is_an_id608_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 85 + archived: false + created_at: 1719493014 + updated_at: 1719493014 + - type: ticket_type_attribute + id: '219' + workspace_id: this_is_an_id608_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 85 + archived: false + created_at: 1719493014 + updated_at: 1719493014 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 50823491-2ab1-4b84-9700-2d92c4f367fd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Ticket Types + operationId: createTicketType + description: "You can create a new ticket type.\n> \U0001F4D8 Creating ticket + types.\n>\n> Every ticket type will be created with two default attributes: + _default_title_ and _default_description_.\n> For the `icon` propery, use + an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + responses: + '200': + description: Ticket type created + content: + application/json: + examples: + Ticket type created: + value: + type: ticket_type + id: '88' + name: Customer Issue + description: Customer Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id612_that_should_be_at_least_ + archived: false + created_at: 1719493016 + updated_at: 1719493016 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '227' + workspace_id: this_is_an_id612_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 88 + archived: false + created_at: 1719493016 + updated_at: 1719493016 + - type: ticket_type_attribute + id: '228' + workspace_id: this_is_an_id612_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 88 + archived: false + created_at: 1719493016 + updated_at: 1719493016 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7c4784fe-d3e4-4182-b9c4-918bdf253eef + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_type_request" + examples: + ticket_type_created: + summary: Ticket type created + value: + name: Customer Issue + description: Customer Report Template + icon: "\U0001F39F️" + category: Customer + "/ticket_types/{id}": + get: + summary: Retrieve a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Types + operationId: getTicketType + description: You can fetch the details of a single ticket type. + responses: + '200': + description: Ticket type found + content: + application/json: + examples: + Ticket type found: + value: + type: ticket_type + id: '90' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id616_that_should_be_at_least_ + archived: false + created_at: 1719493017 + updated_at: 1719493017 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '232' + workspace_id: this_is_an_id616_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 90 + archived: false + created_at: 1719493017 + updated_at: 1719493017 + - type: ticket_type_attribute + id: '234' + workspace_id: this_is_an_id616_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 90 + archived: false + created_at: 1719493017 + updated_at: 1719493017 + - type: ticket_type_attribute + id: '233' + workspace_id: this_is_an_id616_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 90 + archived: false + created_at: 1719493017 + updated_at: 1719493017 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b0100f38-119c-4e30-8560-a25561d97c66 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Types + operationId: updateTicketType + description: "\nYou can update a ticket type.\n\n> \U0001F4D8 Updating a ticket + type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + responses: + '200': + description: Ticket type updated + content: + application/json: + examples: + Ticket type updated: + value: + type: ticket_type + id: '92' + name: Bug Report 2 + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id620_that_should_be_at_least_ + archived: false + created_at: 1719493018 + updated_at: 1719493018 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '238' + workspace_id: this_is_an_id620_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 92 + archived: false + created_at: 1719493018 + updated_at: 1719493018 + - type: ticket_type_attribute + id: '240' + workspace_id: this_is_an_id620_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 92 + archived: false + created_at: 1719493018 + updated_at: 1719493018 + - type: ticket_type_attribute + id: '239' + workspace_id: this_is_an_id620_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 92 + archived: false + created_at: 1719493018 + updated_at: 1719493018 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 2b0554fe-ba10-41d4-ab7b-715c2b7b8e47 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_type_request" + examples: + ticket_type_updated: + summary: Ticket type updated + value: + name: Bug Report 2 + "/tickets/{id}/reply": + post: + summary: Reply to a ticket + operationId: replyTicket + description: You can reply to a ticket with a message from an admin or on behalf + of a contact, or with a note for admins. + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + schema: + title: Ticket ID + type: string + description: The id of the ticket to target. + example: '123' + tags: + - Tickets + responses: + '400': + description: User reply + content: + application/json: + examples: + User reply: + value: + type: error.list + request_id: b8b42c55-347c-4704-b4c1-92220c01f4ac + errors: + - code: parameter_mismatch + message: User replies are not allowed on Backoffice tickets + schema: + "$ref": "#/components/schemas/error" + '200': + description: Admin quick_reply reply + content: + application/json: + examples: + Admin note reply: + value: + type: ticket_part + id: '122' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
    • +
  • Tea
    • +
  • Milk
    • +
+

An Ordered HTML List

+
    +
  1. Coffee
    2. +
  2. Tea
    3. +
  3. Milk
    4. +
+ created_at: 1719493024 + updated_at: 1719493024 + author: + id: '991267829' + type: admin + name: Ciaran375 Lee + email: admin375@email.com + attachments: [] + redacted: false + Admin quick_reply reply: + value: + type: ticket_part + id: '124' + part_type: quick_reply + created_at: 1719493029 + updated_at: 1719493029 + author: + id: '991267834' + type: admin + name: Ciaran379 Lee + email: admin379@email.com + attachments: [] + redacted: false + schema: + "$ref": "#/components/schemas/ticket_reply" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: c23e8dab-6102-483c-bb1b-c62923be35ab + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: bb012854-cca8-4fa7-972e-6c38204e8294 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/contact_reply_ticket_request" + - "$ref": "#/components/schemas/admin_reply_ticket_request" + examples: + user_reply: + summary: User reply + value: + message_type: comment + type: user + intercom_user_id: 667d619d8a68186f43bafe82 + body: Thanks again :) + admin_note_reply: + summary: Admin note reply + value: + message_type: note + type: admin + admin_id: 991267829 + body: "

An Unordered HTML List

  • Coffee
    • + \
  • Tea
  • Milk

An Ordered HTML List

+ \
  1. Coffee
  2. Tea
  3. Milk
+ \ " + admin_quick_reply_reply: + summary: Admin quick_reply reply + value: + message_type: quick_reply + type: admin + admin_id: 991267834 + reply_options: + - text: 'Yes' + uuid: 22d6d1f4-1a19-41d0-94c2-e54031f78aca + - text: 'No' + uuid: fbc3dbe0-ec0c-4fb6-826d-e19127191906 + not_found: + summary: Not found + value: + message_type: comment + type: user + intercom_user_id: 667d61a68a68186f43bafe85 + body: Thanks again :) + "/tickets/{ticket_id}/tags": + post: + summary: Add tag to a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + tags: + - Tags + - Tickets + operationId: attachTagToTicket + description: You can tag a specific ticket. This will return a tag object for + the tag that was added to the ticket. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '134' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Ticket not found + content: + application/json: + examples: + Ticket not found: + value: + type: error.list + request_id: e11d8f55-82fe-4c0d-b4c6-6f22c6a694e9 + errors: + - code: ticket_not_found + message: Ticket not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a502f48f-c80d-48fd-bea5-cafe7e24d9f9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - admin_id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '780' + examples: + successful: + summary: successful + value: + id: 134 + admin_id: 991267844 + ticket_not_found: + summary: Ticket not found + value: + id: 135 + admin_id: 991267847 + "/tickets/{ticket_id}/tags/{id}": + delete: + summary: Remove tag from a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string + tags: + - Tags + - Tickets + operationId: detachTagFromTicket + description: You can remove tag from a specific ticket. This will return a tag + object for the tag that was removed from the ticket. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '137' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Ticket not found: + value: + type: error.list + request_id: ffa08bb4-3994-4132-b9e3-14837e0723e8 + errors: + - code: ticket_not_found + message: Ticket not found + Tag not found: + value: + type: error.list + request_id: d2385995-502c-4c03-bf4b-93ef3d24037b + errors: + - code: tag_not_found + message: Tag not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0d3be117-0a9e-4e88-9a05-4fdd7f93d7bc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - admin_id + properties: + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '123' + examples: + successful: + summary: successful + value: + admin_id: 991267853 + ticket_not_found: + summary: Ticket not found + value: + admin_id: 991267856 + tag_not_found: + summary: Tag not found + value: + admin_id: 991267859 + "/tickets": + post: + summary: Create a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tickets + description: You can create a new ticket. + operationId: createTicket + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: ticket + id: '489' + ticket_id: '48' + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: submitted + ticket_type: + type: ticket_type + id: '106' + name: my-ticket-type-15 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id648_that_should_be_at_least_ + archived: false + created_at: 1719493047 + updated_at: 1719493047 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '252' + workspace_id: this_is_an_id648_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 106 + archived: false + created_at: 1719493047 + updated_at: 1719493047 + - type: ticket_type_attribute + id: '253' + workspace_id: this_is_an_id648_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 106 + archived: false + created_at: 1719493047 + updated_at: 1719493047 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61b78a68186f43bafe8d + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493048 + updated_at: 1719493048 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '125' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493048 + updated_at: 1719493048 + author: + id: '991267871' + type: bot + name: Operator + email: operator+this_is_an_id648_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 745c921a-7c5a-40d4-ab28-6d28a8d2ed47 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_request" + examples: + successful_response: + summary: Successful response + value: + ticket_type_id: 106 + contacts: + - id: 667d61b78a68186f43bafe8d + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + "/tickets/{id}": + put: + summary: Update a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom + schema: + type: string + tags: + - Tickets + operationId: updateTicket + description: You can update a ticket. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: ticket + id: '490' + ticket_id: '49' + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: in_progress + ticket_type: + type: ticket_type + id: '108' + name: my-ticket-type-17 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id652_that_should_be_at_least_ + archived: false + created_at: 1719493050 + updated_at: 1719493050 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '257' + workspace_id: this_is_an_id652_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 108 + archived: false + created_at: 1719493050 + updated_at: 1719493050 + - type: ticket_type_attribute + id: '258' + workspace_id: this_is_an_id652_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 108 + archived: false + created_at: 1719493050 + updated_at: 1719493050 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61bb8a68186f43bafe8e + external_id: cd63b6b5-ea75-4ad9-b72c-9d7a647baf08 + admin_assignee_id: '991267885' + team_assignee_id: '0' + created_at: 1719493051 + updated_at: 1719493054 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '126' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493051 + updated_at: 1719493051 + author: + id: '991267883' + type: admin + name: Ciaran419 Lee + email: admin419@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '127' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '128' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '129' + part_type: ticket_state_updated_by_admin + ticket_state: in_progress + previous_ticket_state: submitted + created_at: 1719493053 + updated_at: 1719493053 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '130' + part_type: assignment + created_at: 1719493054 + updated_at: 1719493054 + assigned_to: + type: admin + id: '991267885' + author: + id: '991267883' + type: admin + name: Ciaran419 Lee + email: admin419@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '131' + part_type: snoozed + created_at: 1719493054 + updated_at: 1719493054 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 6 + open: true + snoozed_until: 1719590400 + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: In progress + ticket_state_external_label: In progress + schema: + "$ref": "#/components/schemas/ticket" + '404': + description: Assignee not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 809aceaa-c073-4e2a-96c3-a25e15576946 + errors: + - code: assignee_not_found + message: Assignee not found + Assignee not found: + value: + type: error.list + request_id: 639b5b51-1eb9-4c06-8de4-d9b0e30fff05 + errors: + - code: assignee_not_found + message: Assignee not found + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e5202025-e8f9-400a-9107-192ae8bfd50c + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_request" + examples: + successful_response: + summary: Successful response + value: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '991267883' + assignee_id: '991267885' + open: true + snoozed_until: 1673609604 + admin_not_found: + summary: Admin not found + value: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '123' + assignee_id: '991267893' + assignee_not_found: + summary: Assignee not found + value: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '991267899' + assignee_id: '456' + get: + summary: Retrieve a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom. + schema: + type: string + tags: + - Tickets + operationId: getTicket + description: You can fetch the details of a single ticket. + responses: + '200': + description: Ticket found + content: + application/json: + examples: + Ticket found: + value: + type: ticket + id: '493' + ticket_id: '52' + ticket_attributes: + _default_title_: attribute_value + _default_description_: + ticket_state: submitted + ticket_type: + type: ticket_type + id: '112' + name: my-ticket-type-21 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id660_that_should_be_at_least_ + archived: false + created_at: 1719493060 + updated_at: 1719493060 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '268' + workspace_id: this_is_an_id660_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 112 + archived: false + created_at: 1719493060 + updated_at: 1719493060 + - type: ticket_type_attribute + id: '269' + workspace_id: this_is_an_id660_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 112 + archived: false + created_at: 1719493060 + updated_at: 1719493060 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61c48a68186f43bafe91 + external_id: '038050f6-d917-4b9d-89cb-539b1d371172' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493061 + updated_at: 1719493061 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '134' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493061 + updated_at: 1719493061 + author: + id: '991267912' + type: admin + name: Ciaran445 Lee + email: admin445@email.com + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e7ba89f2-3bc8-4fc3-97bc-56f62f342680 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/tickets/search": + post: + summary: Search tickets + operationId: searchTickets + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tickets + description: | + You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + + To search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`. + + This will accept a query object in the body which will define your filters. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiples there can be: + - There's a limit of max 2 nested filters + - There's a limit of max 15 filters for each AND or OR group + + ### Accepted Fields + + Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foobar"`). + + | Field | Type | + | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + | id | String | + | created_at | Date (UNIX timestamp) | + | updated_at | Date (UNIX timestamp) | + | _default_title_ | String | + | _default_description_ | String | + | category | String | + | ticket_type_id | String | + | contact_ids | String | + | teammate_ids | String | + | admin_assignee_id | String | + | team_assignee_id | String | + | open | Boolean | + | state | String | + | snoozed_until | Date (UNIX timestamp) | + | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + + ### Accepted Operators + + {% admonition type="info" name="Searching based on `created_at`" %} + You may use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :----------------------------- | :----------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In Shortcut for `OR` queries Values most be in Array | + | NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | + | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: ticket.list + pages: + type: pages + page: 1 + per_page: 5 + total_pages: 1 + total_count: 1 + tickets: + - type: ticket + id: '494' + ticket_id: '53' + ticket_attributes: + _default_title_: attribute_value + _default_description_: + ticket_state: submitted + ticket_type: + type: ticket_type + id: '117' + name: my-ticket-type-26 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id667_that_should_be_at_least_ + archived: false + created_at: 1719493065 + updated_at: 1719493065 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '279' + workspace_id: this_is_an_id667_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 117 + archived: false + created_at: 1719493065 + updated_at: 1719493065 + - type: ticket_type_attribute + id: '280' + workspace_id: this_is_an_id667_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 117 + archived: false + created_at: 1719493065 + updated_at: 1719493065 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61c98a68186f43bafe92 + external_id: 6895b33e-2768-4611-908e-da6632dfc8ea + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493065 + updated_at: 1719493066 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '135' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493066 + updated_at: 1719493066 + author: + id: '991267940' + type: admin + name: Ciaran472 Lee + email: admin472@email.com + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket_list" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: created_at + operator: ">" + value: '1306054154' + pagination: + per_page: 5 + "/visitors": + put: + summary: Update a visitor + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Visitors + operationId: updateVisitor + description: | + Sending a PUT request to `/visitors` will result in an update of an existing Visitor. + + **Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body. + + **Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: visitor + id: 667d61cc8a68186f43bafe95 + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: + name: Gareth Bale + pseudonym: Indigo Ghost + avatar: + type: avatar + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png + app_id: this_is_an_id671_that_should_be_at_least_ + companies: + type: company.list + companies: [] + location_data: {} + last_request_at: + created_at: 1719493068 + remote_created_at: 1719493068 + signed_up_at: 1719493068 + updated_at: 1719493068 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: [] + owner_id: + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + custom_attributes: {} + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: + schema: + "$ref": "#/components/schemas/visitor" + '404': + description: visitor Not Found + content: + application/json: + examples: + visitor Not Found: + value: + type: error.list + request_id: 1f35dc86-17d2-4bfe-8cb1-9afa74adc24c + errors: + - code: not_found + message: Visitor Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 82df3971-fb7c-410d-a919-e8bc1b3d991a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_visitor_request" + examples: + successful: + summary: successful + value: + id: 667d61cc8a68186f43bafe95 + name: Gareth Bale + visitor_not_found: + summary: visitor Not Found + value: + user_id: fail + name: Christian Fail + get: + summary: Retrieve a visitor with User ID + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: user_id + in: query + description: The user_id of the Visitor you want to retrieve. + required: true + schema: + type: string + tags: + - Visitors + operationId: retrieveVisitorWithUserId + description: You can fetch the details of a single visitor. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: visitor + id: 667d61ce8a68186f43bafe9b + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: + name: + pseudonym: + avatar: + type: avatar + image_url: + app_id: this_is_an_id677_that_should_be_at_least_ + companies: + type: company.list + companies: [] + location_data: {} + last_request_at: + created_at: 1719493070 + remote_created_at: 1719493070 + signed_up_at: 1719493070 + updated_at: 1719493070 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: [] + owner_id: + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + custom_attributes: {} + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: + schema: + "$ref": "#/components/schemas/visitor" + '404': + description: Visitor not found + content: + application/json: + examples: + Visitor not found: + value: + type: error.list + request_id: 7359afef-98f5-4b22-9de7-902f7a214729 + errors: + - code: not_found + message: Visitor Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 25dace4f-4916-492c-823b-f0cca227dff0 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/visitors/convert": + post: + summary: Convert a visitor + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Visitors + operationId: convertVisitor + description: "You can merge a Visitor to a Contact of role type `lead` or `user`.\n\n> + \U0001F4D8 What happens upon a visitor being converted?\n>\n> If the User + exists, then the Visitor will be merged into it, the Visitor deleted and the + User returned. If the User does not exist, the Visitor will be converted to + a User, with the User identifiers replacing it's Visitor identifiers.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d61d08a68186f43bafea2 + workspace_id: this_is_an_id683_that_should_be_at_least_ + external_id: + role: user + email: foo@bar.com + phone: + name: + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719493072 + updated_at: 1719493072 + signed_up_at: 1719493072 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: fe1a587a-e682-4a96-bd30-ea08b726e6fa + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/convert_visitor_request" + examples: + successful: + summary: successful + value: + visitor: + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + user: + email: foo@bar.com + type: user +components: + schemas: + activity_log: + title: Activity Log + type: object + description: Activities performed by Admins. + nullable: true + properties: + id: + type: string + description: The id representing the activity. + example: '6' + performed_by: + type: object + description: Details about the Admin involved in the activity. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + email: + type: string + description: The email of the admin. + example: john@example.com + ip: + type: string + description: The IP address of the admin. + example: 198.51.100.255 + metadata: + "$ref": "#/components/schemas/activity_log_metadata" + created_at: + type: integer + format: date-time + description: The time the activity was created. + example: 1671028894 + activity_type: + type: string + enum: + - admin_assignment_limit_change + - admin_away_mode_change + - admin_deletion + - admin_deprovisioned + - admin_impersonation_end + - admin_impersonation_start + - admin_invite_change + - admin_invite_creation + - admin_invite_deletion + - admin_login_failure + - admin_login_success + - admin_logout + - admin_password_reset_request + - admin_password_reset_success + - admin_permission_change + - admin_provisioned + - admin_two_factor_auth_change + - admin_unauthorized_sign_in_method + - app_admin_join + - app_authentication_method_change + - app_data_deletion + - app_data_export + - app_google_sso_domain_change + - app_identity_verification_change + - app_name_change + - app_outbound_address_change + - app_package_installation + - app_package_token_regeneration + - app_package_uninstallation + - app_team_creation + - app_team_deletion + - app_team_membership_modification + - app_timezone_change + - app_webhook_creation + - app_webhook_deletion + - articles_in_messenger_enabled_change + - bulk_delete + - bulk_export + - campaign_deletion + - campaign_state_change + - conversation_part_deletion + - conversation_topic_change + - conversation_topic_creation + - conversation_topic_deletion + - help_center_settings_change + - inbound_conversations_change + - inbox_access_change + - message_deletion + - message_state_change + - messenger_look_and_feel_change + - messenger_search_required_change + - messenger_spaces_change + - office_hours_change + - role_change + - role_creation + - role_deletion + - ruleset_activation_title_preview + - ruleset_creation + - ruleset_deletion + - search_browse_enabled_change + - search_browse_required_change + - seat_change + - seat_revoke + - security_settings_change + - temporary_expectation_change + - upfront_email_collection_change + - welcome_message_change + example: app_name_change + activity_description: + type: string + description: A sentence or two describing the activity. + example: Admin updated the app's name to "My App". + activity_log_list: + title: Paginated Response + type: object + description: A paginated list of activity logs. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `activity_log.list`. + example: activity_log.list + pages: + "$ref": "#/components/schemas/cursor_pages" + activity_logs: + type: array + description: An array of activity logs + items: + "$ref": "#/components/schemas/activity_log" + activity_log_metadata: + title: Activity Log Metadata + type: object + description: Additional data provided about Admin activity. + nullable: true + properties: + sign_in_method: + type: string + nullable: true + description: The way the admin signed in. + example: email_password + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + away_mode: + type: boolean + nullable: true + description: The away mode status which is set to true when away and false + when returned. + example: true + away_status_reason: + type: string + nullable: true + description: The reason the Admin is away. + example: "\U0001F60C On a break" + reassign_conversations: + type: boolean + nullable: true + description: Indicates if conversations should be reassigned while an Admin + is away. + example: false + source: + type: string + nullable: true + description: The action that initiated the status change. + example: 'admin update from web - Admin id: 93' + auto_changed: + type: string + nullable: true + description: Indicates if the status was changed automatically or manually. + example: false + update_by: + type: integer + nullable: true + description: The ID of the Admin who initiated the activity. + example: 93 + update_by_name: + type: string + nullable: true + description: The name of the Admin who initiated the activity. + example: Joe Bloggs + addressable_list: + title: Addressable List + type: object + nullable: false + description: A list used to access other resources from a parent model. + properties: + type: + type: string + format: uri + description: The addressable object type + example: note + id: + type: string + description: The id of the addressable object + example: '123' + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" + admin: + title: Admin + type: object + x-tags: + - Admins + description: Admins are teammate accounts that have access to a workspace. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + name: + type: string + description: The name of the admin. + example: Hoban Washburne + email: + type: string + description: The email of the admin. + example: wash@serenity.io + job_title: + type: string + description: The job title of the admin. + example: Philosopher + away_mode_enabled: + type: boolean + description: Identifies if this admin is currently set in away mode. + example: false + away_mode_reassign: + type: boolean + description: Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + example: false + has_inbox_seat: + type: boolean + description: Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + example: true + team_ids: + type: array + description: This object represents the avatar associated with the admin. + example: + - 814865 + items: + type: integer + avatar: + type: string + format: uri + nullable: true + description: Image for the associated team or teammate + example: https://picsum.photos/200/300 + team_priority_level: + "$ref": "#/components/schemas/team_priority_level" + admin_list: + title: Admins + type: object + description: A list of admins associated with a given workspace. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin.list`. + example: admin.list + admins: + type: array + description: A list of admins associated with a given workspace. + items: + "$ref": "#/components/schemas/admin" + admin_priority_level: + title: Admin Priority Level + type: object + nullable: true + description: Admin priority levels for the team + properties: + primary_admin_ids: + type: array + description: The primary admin ids for the team + nullable: true + example: + - 493881 + items: + type: integer + secondary_admin_ids: + type: array + description: The secondary admin ids for the team + nullable: true + example: + - 814865 + items: + type: integer + admin_reply_conversation_request: + title: Admin Reply + type: object + description: Payload of the request to reply on behalf of an admin + properties: + message_type: + type: string + enum: + - comment + - note + type: + type: string + enum: + - admin + example: admin + body: + type: string + description: The text body of the reply. Notes accept some HTML formatting. + Must be present for comment and note message types. + example: Hello there! + admin_id: + type: string + description: The id of the admin who is authoring the comment. + example: '3156780' + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + attachment_files: + type: array + description: A list of files that will be added as attachments. You can + include up to 10 files + items: + "$ref": "#/components/schemas/conversation_attachment_files" + maxItems: 10 + required: + - message_type + - type + - admin_id + admin_reply_ticket_request: + title: Admin Reply on ticket + type: object + description: Payload of the request to reply on behalf of an admin + properties: + message_type: + type: string + enum: + - comment + - note + - quick_reply + example: comment + type: + type: string + enum: + - admin + example: admin + body: + type: string + description: The text body of the reply. Notes accept some HTML formatting. + Must be present for comment and note message types. + example: Hello there! + admin_id: + type: string + description: The id of the admin who is authoring the comment. + example: '3156780' + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + reply_options: + title: Quick Reply Options + type: array + description: The quick reply options to display. Must be present for quick_reply + message types. + items: + title: Quick Reply Option + type: object + properties: + text: + type: string + description: The text to display in this quick reply option. + uuid: + type: string + format: uuid + description: A unique identifier for this quick reply option. This + value will be available within the metadata of the comment ticket + part that is created when a user clicks on this reply option. + required: + - text + - uuid + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + required: + - message_type + - type + - admin_id + admin_with_app: + title: Admin + type: object + description: Admins are the teammate accounts that have access to a workspace + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + name: + type: string + description: The name of the admin. + example: Hoban Washburne + email: + type: string + description: The email of the admin. + example: wash@serenity.io + job_title: + type: string + description: The job title of the admin. + example: Philosopher + away_mode_enabled: + type: boolean + description: Identifies if this admin is currently set in away mode. + example: false + away_mode_reassign: + type: boolean + description: Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + example: false + has_inbox_seat: + type: boolean + description: Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + example: true + team_ids: + type: array + description: This is a list of ids of the teams that this admin is part + of. + example: + - 814865 + items: + type: integer + avatar: + type: object + description: This object represents the avatar associated with the admin. + properties: + type: + type: string + description: This is a string that identifies the type of the object. + It will always have the value `avatar`. + default: avatar + example: avatar + image_url: + type: string + format: uri + nullable: true + description: This object represents the avatar associated with the admin. + example: https://example.com/avatar.png + email_verified: + type: boolean + description: Identifies if this admin's email is verified. + nullable: true + example: true + app: + "$ref": "#/components/schemas/app" + nullable: true + description: App that the admin belongs to. + ai_agent: + title: AI Agent + type: object + x-tags: + - Ai Agent + description: Data related to AI Agent involvement in the conversation. + properties: + source_type: + type: string + description: The type of the source that triggered AI Agent involvement + in the conversation. + enum: + - essentials_plan_setup + - profile + - workflow + - workflow_preview + - fin_preview + example: workflow + source_title: + type: string + description: The title of the source that triggered AI Agent involvement + in the conversation. If this is `essentials_plan_setup` then it will return + `null`. + example: My AI Workflow + nullable: true + last_answer_type: + type: string + description: The type of the last answer delivered by AI Agent. If no answer + was delivered then this will return `null` + enum: + - + - ai_answer + - custom_answer + example: ai_answer + nullable: true + resolution_state: + type: string + description: The resolution state of AI Agent. If no AI or custom answer + has been delivered then this will return `null`. + enum: + - assumed_resolution + - confirmed_resolution + - routed_to_team + - abandoned + - + example: assumed_resolution + nullable: true + rating: + type: integer + description: The customer satisfaction rating given to AI Agent, from 1-5. + example: 4 + nullable: true + rating_remark: + type: string + description: The customer satisfaction rating remark given to AI Agent. + example: Very helpful! + nullable: true + content_sources: + "$ref": "#/components/schemas/content_sources_list" + app: + title: App + type: object + description: App is a workspace on Intercom + nullable: true + properties: + type: + type: string + description: '' + default: app + example: app + id_code: + type: string + description: The id of the app. + example: xyz789 + name: + type: string + description: The name of the app. + example: ACME + region: + type: string + description: The Intercom region the app is located in. + example: US + timezone: + type: string + description: The timezone of the region where the app is located. + example: America/Los_Angeles + created_at: + type: integer + description: When the app was created. + example: 1671465577 + identity_verification: + type: boolean + description: Whether or not the app uses identity verification. + example: false + article: + title: Article + type: object + x-tags: + - Articles + description: The Articles API is a central place to gather all information and + take actions on your articles. Articles can live within collections and sections, + or alternatively they can stand alone. + properties: + statistics: + nullable: true + "$ref": "#/components/schemas/article_statistics" + allOf: + - "$ref": "#/components/schemas/article_list_item" + article_content: + title: Article Content + type: object + description: The Content of an Article. + nullable: true + properties: + type: + type: string + description: The type of object - `article_content` . + enum: + - + - article_content + example: article_content + nullable: true + title: + type: string + description: The title of the article. + example: How to create a new article + description: + type: string + description: The description of the article. + example: This article will show you how to create a new article. + body: + type: string + description: The body of the article. + example: This is the body of the article. + author_id: + type: integer + description: The ID of the author of the article. + example: '5017691' + state: + type: string + description: Whether the article is `published` or is a `draft` . + enum: + - published + - draft + example: draft + created_at: + type: integer + format: date-time + description: The time when the article was created (seconds). + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated (seconds). + example: 1663597260 + url: + type: string + description: The URL of the article. + example: http://intercom.test/help/en/articles/3-default-language + article_list: + title: Articles + type: object + description: This will return a list of articles for the App. + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of articles. + example: 1 + data: + type: array + description: An array of Article objects + items: + "$ref": "#/components/schemas/article_list_item" + article_list_item: + title: Articles + type: object + x-tags: + - Articles + description: The data returned about your articles when you list them. + properties: + type: + type: string + description: The type of object - `article`. + enum: + - article + default: article + example: article + id: + type: string + description: The unique identifier for the article which is given by Intercom. + example: '6871119' + workspace_id: + type: string + description: The id of the workspace which the article belongs to. + example: hfi1bx4l + title: + type: string + description: The title of the article. For multilingual articles, this will + be the title of the default language's content. + example: Default language title + description: + type: string + nullable: true + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Default language description + body: + type: string + nullable: true + description: The body of the article in HTML. For multilingual articles, + this will be the body of the default language's content. + example: Default language body in html + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: '5017691' + state: + type: string + description: Whether the article is `published` or is a `draft`. For multilingual + articles, this will be the state of the default language's content. + enum: + - published + - draft + default: draft + example: published + created_at: + type: integer + format: date-time + description: The time when the article was created. For multilingual articles, + this will be the timestamp of creation of the default language's content + in seconds. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated. For multilingual + articles, this will be the timestamp of last update of the default language's + content in seconds. + example: 1672928610 + url: + type: string + nullable: true + description: The URL of the article. For multilingual articles, this will + be the URL of the default language's content. + example: http://intercom.test/help/en/articles/3-default-language + parent_id: + type: integer + nullable: true + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: '125685' + parent_ids: + type: array + description: The ids of the article's parent collections or sections. An + article without this field stands alone. + items: + type: integer + example: + - 18 + - 19 + parent_type: + type: string + nullable: true + description: The type of parent, which can either be a `collection` or `section`. + example: collection + default_locale: + type: string + description: The default locale of the help center. This field is only returned + for multilingual help centers. + example: en + translated_content: + nullable: true + "$ref": "#/components/schemas/article_translated_content" + article_search_highlights: + title: Article Search Highlights + type: object + x-tags: + - Articles + description: The highlighted results of an Article search. In the examples provided + my search query is always "my query". + properties: + article_id: + type: string + description: The ID of the corresponding article. + example: '123' + highlighted_title: + type: array + description: An Article title highlighted. + items: + type: object + description: A highlighted article title. + properties: + type: + type: string + description: The type of text - `highlight` or `plain`. + enum: + - highlight + - plain + example: 'The highlight is ' + text: + type: string + description: The text of the title. + example: my query + highlighted_summary: + type: array + description: An Article description and body text highlighted. + items: + type: array + description: An array containing the highlighted summary text split into + chunks of plain and highlighted text. + items: + type: object + description: An instance of highlighted summary text. + properties: + type: + type: string + description: The type of text - `highlight` or `plain`. + enum: + - highlight + - plain + example: 'How to highlight ' + text: + type: string + description: The text of the title. + example: my query + article_search_response: + title: Article Search Response + type: object + x-tags: + - Articles + description: The results of an Article search + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + total_count: + type: integer + description: The total number of Articles matching the search query + example: 5 + data: + type: object + description: An object containing the results of the search. + properties: + articles: + type: array + description: An array of Article objects + items: + "$ref": "#/components/schemas/article" + highlights: + type: array + description: A corresponding array of highlighted Article content + items: + "$ref": "#/components/schemas/article_search_highlights" + pages: + "$ref": "#/components/schemas/cursor_pages" + article_statistics: + title: Article Statistics + type: object + description: The statistics of an article. + nullable: true + properties: + type: + type: string + description: The type of object - `article_statistics`. + enum: + - article_statistics + default: article_statistics + example: article_statistics + views: + type: integer + description: The number of total views the article has received. + example: 10 + conversions: + type: integer + description: The number of conversations started from the article. + example: 0 + reactions: + type: integer + description: The number of total reactions the article has received. + example: 10 + happy_reaction_percentage: + type: number + format: float + description: The percentage of happy reactions the article has received + against other types of reaction. + example: 40.0 + neutral_reaction_percentage: + type: number + format: float + description: The percentage of neutral reactions the article has received + against other types of reaction. + example: 40.0 + sad_reaction_percentage: + type: number + format: float + description: The percentage of sad reactions the article has received against + other types of reaction. + example: 20.0 + article_translated_content: + title: Article Translated Content + type: object + description: The Translated Content of an Article. The keys are the locale codes + and the values are the translated content of the article. + nullable: true + properties: + type: + type: string + description: The type of object - article_translated_content. + enum: + - + - article_translated_content + example: article_translated_content + nullable: true + ar: + description: The content of the article in Arabic + "$ref": "#/components/schemas/article_content" + bg: + description: The content of the article in Bulgarian + "$ref": "#/components/schemas/article_content" + bs: + description: The content of the article in Bosnian + "$ref": "#/components/schemas/article_content" + ca: + description: The content of the article in Catalan + "$ref": "#/components/schemas/article_content" + cs: + description: The content of the article in Czech + "$ref": "#/components/schemas/article_content" + da: + description: The content of the article in Danish + "$ref": "#/components/schemas/article_content" + de: + description: The content of the article in German + "$ref": "#/components/schemas/article_content" + el: + description: The content of the article in Greek + "$ref": "#/components/schemas/article_content" + en: + description: The content of the article in English + "$ref": "#/components/schemas/article_content" + es: + description: The content of the article in Spanish + "$ref": "#/components/schemas/article_content" + et: + description: The content of the article in Estonian + "$ref": "#/components/schemas/article_content" + fi: + description: The content of the article in Finnish + "$ref": "#/components/schemas/article_content" + fr: + description: The content of the article in French + "$ref": "#/components/schemas/article_content" + he: + description: The content of the article in Hebrew + "$ref": "#/components/schemas/article_content" + hr: + description: The content of the article in Croatian + "$ref": "#/components/schemas/article_content" + hu: + description: The content of the article in Hungarian + "$ref": "#/components/schemas/article_content" + id: + description: The content of the article in Indonesian + "$ref": "#/components/schemas/article_content" + it: + description: The content of the article in Italian + "$ref": "#/components/schemas/article_content" + ja: + description: The content of the article in Japanese + "$ref": "#/components/schemas/article_content" + ko: + description: The content of the article in Korean + "$ref": "#/components/schemas/article_content" + lt: + description: The content of the article in Lithuanian + "$ref": "#/components/schemas/article_content" + lv: + description: The content of the article in Latvian + "$ref": "#/components/schemas/article_content" + mn: + description: The content of the article in Mongolian + "$ref": "#/components/schemas/article_content" + nb: + description: The content of the article in Norwegian + "$ref": "#/components/schemas/article_content" + nl: + description: The content of the article in Dutch + "$ref": "#/components/schemas/article_content" + pl: + description: The content of the article in Polish + "$ref": "#/components/schemas/article_content" + pt: + description: The content of the article in Portuguese (Portugal) + "$ref": "#/components/schemas/article_content" + ro: + description: The content of the article in Romanian + "$ref": "#/components/schemas/article_content" + ru: + description: The content of the article in Russian + "$ref": "#/components/schemas/article_content" + sl: + description: The content of the article in Slovenian + "$ref": "#/components/schemas/article_content" + sr: + description: The content of the article in Serbian + "$ref": "#/components/schemas/article_content" + sv: + description: The content of the article in Swedish + "$ref": "#/components/schemas/article_content" + tr: + description: The content of the article in Turkish + "$ref": "#/components/schemas/article_content" + vi: + description: The content of the article in Vietnamese + "$ref": "#/components/schemas/article_content" + pt-BR: + description: The content of the article in Portuguese (Brazil) + "$ref": "#/components/schemas/article_content" + zh-CN: + description: The content of the article in Chinese (China) + "$ref": "#/components/schemas/article_content" + zh-TW: + description: The content of the article in Chinese (Taiwan) + "$ref": "#/components/schemas/article_content" + assign_conversation_request: + title: Assign Conversation Request + type: object + description: Payload of the request to assign a conversation + properties: + message_type: + type: string + enum: + - assignment + example: assignment + type: + type: string + enum: + - admin + - team + example: admin + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '12345' + assignee_id: + type: string + description: The `id` of the `admin` or `team` which will be assigned the + conversation. A conversation can be assigned both an admin and a team.\nSet + `0` if you want this assign to no admin or team (ie. Unassigned). + example: '4324241' + body: + type: string + description: Optionally you can send a response in the conversation when + it is assigned. + example: Let me pass you over to one of my colleagues. + required: + - message_type + - type + - admin_id + - assignee_id + attach_contact_to_conversation_request: + title: Assign Conversation Request + type: object + description: Payload of the request to assign a conversation + properties: + admin_id: + type: string + description: The `id` of the admin who is adding the new participant. + example: '12345' + customer: + type: object + oneOf: + - title: Intercom User ID + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + example: 6329bd9ffe4e2e91dac76188 + customer: + "$ref": "#/components/schemas/customer_request" + required: + - intercom_user_id + - title: User ID + properties: + user_id: + type: string + description: The external_id you have defined for the contact who + is being added as a participant. + example: 6329bd9ffe4e2e91dac76188 + customer: + "$ref": "#/components/schemas/customer_request" + required: + - user_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being + added as a participant. + example: winstonsmith@truth.org + customer: + "$ref": "#/components/schemas/customer_request" + required: + - email + close_conversation_request: + title: Close Conversation Request + type: object + description: Payload of the request to close a conversation + properties: + message_type: + type: string + enum: + - close + example: close + type: + type: string + enum: + - admin + example: admin + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '12345' + body: + type: string + description: Optionally you can leave a message in the conversation to provide + additional context to the user and other teammates. + example: " This conversation is now closed!" + required: + - message_type + - type + - admin_id + collection: + title: Collection + type: object + x-tags: + - Help Center + description: Collections are top level containers for Articles within the Help + Center. + properties: + id: + type: string + description: The unique identifier for the collection which is given by + Intercom. + example: '6871119' + workspace_id: + type: string + description: The id of the workspace which the collection belongs to. + example: hfi1bx4l + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: Default language name + description: + type: string + nullable: true + description: The description of the collection. For multilingual help centers, + this will be the description of the collection for the default language. + example: Default language description + created_at: + type: integer + format: date-time + description: The time when the article was created (seconds). For multilingual + articles, this will be the timestamp of creation of the default language's + content. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated (seconds). For multilingual + articles, this will be the timestamp of last update of the default language's + content. + example: 1672928610 + url: + type: string + nullable: true + description: The URL of the collection. For multilingual help centers, this + will be the URL of the collection for the default language. + example: http://intercom.test/help/collection/name + icon: + type: string + nullable: true + description: The icon of the collection. + example: book-bookmark + order: + type: integer + description: The order of the section in relation to others sections within + a collection. Values go from `0` upwards. `0` is the default if there's + no order. + example: '1' + default_locale: + type: string + description: The default locale of the help center. This field is only returned + for multilingual help centers. + example: en + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it is the first + level collection. + example: '6871118' + help_center_id: + type: integer + nullable: true + description: The id of the help center the collection is in. + example: '123' + collection_list: + title: Collections + type: object + description: This will return a list of Collections for the App. + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of collections. + example: 1 + data: + type: array + description: An array of collection objects + items: + "$ref": "#/components/schemas/collection" + company: + title: Company + type: object + x-tags: + - Companies + description: Companies allow you to represent organizations using your product. + Each company will have its own description and be associated with contacts. + You can fetch, create, update and list companies. + properties: + type: + type: string + description: Value is `company` + enum: + - company + example: company + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + name: + type: string + description: The name of the company. + example: Blue Sun + app_id: + type: string + description: The Intercom defined code of the workspace the company is associated + to. + example: ecahpwf5 + plan: + type: object + properties: + type: + type: string + description: Value is always "plan" + example: plan + id: + type: string + description: The id of the plan + example: '269315' + name: + type: string + description: The name of the plan + example: Pro + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + remote_created_at: + type: integer + description: The time the company was created by you. + example: 1663597223 + created_at: + type: integer + description: The time the company was added in Intercom. + example: 1663597223 + updated_at: + type: integer + description: The last time the company was updated. + example: 1663597223 + last_request_at: + type: integer + description: The time the company last recorded making a request. + example: 1663597223 + size: + type: integer + description: The number of employees in the company. + example: 100 + website: + type: string + description: The URL for the company website. + example: https://www.intercom.com + industry: + type: string + description: The industry that the company operates in. + example: Software + monthly_spend: + type: integer + description: How much revenue the company generates for your business. + example: 100 + session_count: + type: integer + description: How many sessions the company has recorded. + example: 100 + user_count: + type: integer + description: The number of users in the company. + example: 100 + custom_attributes: + type: object + description: The custom attributes you have set on the company. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + tags: + type: object + description: The list of tags associated with the company + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + tags: + type: array + items: + items: + "$ref": "#/components/schemas/tag" + segments: + type: object + description: The list of segments associated with the company + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + segments: + type: array + items: + "$ref": "#/components/schemas/segment" + company_attached_contacts: + title: Company Attached Contacts + type: object + description: A list of Contact Objects + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + description: An array containing Contact Objects + items: + "$ref": "#/components/schemas/contact" + total_count: + type: integer + description: The total number of contacts + example: 100 + pages: + "$ref": "#/components/schemas/cursor_pages" + company_attached_segments: + title: Company Attached Segments + type: object + description: A list of Segment Objects + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + description: An array containing Segment Objects + items: + "$ref": "#/components/schemas/segment" + company_list: + title: Companies + type: object + description: This will return a list of companies for the App. + properties: + type: + type: string + description: The type of object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: The total number of companies. + example: 100 + data: + type: array + description: An array containing Company Objects. + items: + "$ref": "#/components/schemas/company" + company_scroll: + title: Company Scroll + type: object + description: Companies allow you to represent organizations using your product. + Each company will have its own description and be associated with contacts. + You can fetch, create, update and list companies. + nullable: true + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + items: + "$ref": "#/components/schemas/company" + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: The total number of companies + nullable: true + example: 100 + scroll_param: + type: string + description: The scroll parameter to use in the next request to fetch the + next page of results. + example: 25b649f7-4d33-4ef6-88f5-60e5b8244309 + contact: + title: Contact + type: object + x-tags: + - Contacts + description: Contact are the objects that represent your leads and users in + Intercom. + properties: + type: + type: string + description: The type of object. + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + workspace_id: + type: string + description: The id of the workspace which the contact belongs to. + example: ecahpwf5 + role: + type: string + description: The role of the contact. + example: user + email: + type: string + description: The contact's email. + example: joe@example.com + email_domain: + type: string + description: The contact's email domain. + example: example.com + phone: + type: string + nullable: true + description: The contacts phone. + example: "+1123456789" + formatted_phone: + type: string + nullable: true + description: The contacts phone number normalized to the E164 format + example: "+1123456789" + name: + type: string + nullable: true + description: The contacts name. + example: John Doe + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact. + example: 123 + has_hard_bounced: + type: boolean + description: Whether the contact has had an email sent to them hard bounce. + example: true + marked_email_as_spam: + type: boolean + description: Whether the contact has marked an email sent to them as spam. + example: true + unsubscribed_from_emails: + type: boolean + description: Whether the contact is unsubscribed from emails. + example: true + created_at: + type: integer + format: date-time + description: "(UNIX timestamp) The time when the contact was created." + example: 1571672154 + updated_at: + type: integer + format: date-time + description: "(UNIX timestamp) The time when the contact was last updated." + example: 1571672154 + signed_up_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time specified for when a contact signed + up." + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact was last seen (either + where the Intercom Messenger was installed or when specified manually)." + example: 1571672154 + last_replied_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last messaged in." + example: 1571672154 + last_contacted_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact was last messaged." + example: 1571672154 + last_email_opened_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last opened an + email." + example: 1571672154 + last_email_clicked_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last clicked a + link in an email." + example: 1571672154 + language_override: + type: string + nullable: true + description: A preferred language setting for the contact, used by the Intercom + Messenger even if their browser settings change. + example: en + browser: + type: string + nullable: true + description: The name of the browser which the contact is using. + example: Chrome + browser_version: + type: string + nullable: true + description: The version of the browser which the contact is using. + example: 80.0.3987.132 + browser_language: + type: string + nullable: true + description: The language set by the browser which the contact is using. + example: en-US + os: + type: string + nullable: true + description: The operating system which the contact is using. + example: Mac OS X + android_app_name: + type: string + nullable: true + description: The name of the Android app which the contact is using. + example: Intercom + android_app_version: + type: string + nullable: true + description: The version of the Android app which the contact is using. + example: 5.0.0 + android_device: + type: string + nullable: true + description: The Android device which the contact is using. + example: Pixel 3 + android_os_version: + type: string + nullable: true + description: The version of the Android OS which the contact is using. + example: '10' + android_sdk_version: + type: string + nullable: true + description: The version of the Android SDK which the contact is using. + example: '28' + android_last_seen_at: + type: integer + nullable: true + format: date-time + description: "(UNIX timestamp) The time when the contact was last seen on + an Android device." + example: 1571672154 + ios_app_name: + type: string + nullable: true + description: The name of the iOS app which the contact is using. + example: Intercom + ios_app_version: + type: string + nullable: true + description: The version of the iOS app which the contact is using. + example: 5.0.0 + ios_device: + type: string + nullable: true + description: The iOS device which the contact is using. + example: iPhone 11 + ios_os_version: + type: string + nullable: true + description: The version of iOS which the contact is using. + example: 13.3.1 + ios_sdk_version: + type: string + nullable: true + description: The version of the iOS SDK which the contact is using. + example: 13.3.1 + ios_last_seen_at: + type: integer + nullable: true + format: date-time + description: "(UNIX timestamp) The last time the contact used the iOS app." + example: 1571672154 + custom_attributes: + type: object + description: The custom attributes which are set for the contact. + avatar: + type: object + nullable: true + properties: + type: + type: string + description: The type of object + example: avatar + image_url: + type: string + format: uri + nullable: true + description: An image URL containing the avatar of a contact. + example: https://example.org/128Wash.jpg + tags: + "$ref": "#/components/schemas/contact_tags" + notes: + "$ref": "#/components/schemas/contact_notes" + companies: + "$ref": "#/components/schemas/contact_companies" + location: + "$ref": "#/components/schemas/contact_location" + social_profiles: + "$ref": "#/components/schemas/contact_social_profiles" + contact_archived: + title: Contact Archived + type: object + description: archived contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + archived: + type: boolean + description: Whether the contact is archived or not. + example: true + contact_attached_companies: + title: Contact Attached Companies + type: object + description: A list of Company Objects + properties: + type: + type: string + description: The type of object + enum: + - list + example: list + companies: + type: array + description: An array containing Company Objects + items: + "$ref": "#/components/schemas/company" + total_count: + type: integer + description: The total number of companies associated to this contact + example: 100 + pages: + "$ref": "#/components/schemas/pages_link" + contact_companies: + title: Contact companies + type: object + nullable: false + description: An object containing companies meta data about the companies that + a contact has. Up to 10 will be displayed here. Use the url to get more. + properties: + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/companies" + total_count: + type: integer + description: Int representing the total number of companyies attached to + this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_deleted: + title: Contact Deleted + type: object + description: deleted contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + deleted: + type: boolean + description: Whether the contact is deleted or not. + example: true + contact_list: + title: Contact List + type: object + description: Contacts are your users in Intercom. + properties: + type: + type: string + description: Always list + enum: + - list + example: list + data: + type: array + description: The list of contact objects + items: + "$ref": "#/components/schemas/contact" + total_count: + type: integer + description: A count of the total number of objects. + example: 100 + pages: + "$ref": "#/components/schemas/cursor_pages" + contact_location: + title: Contact Location + type: object + nullable: false + description: An object containing location meta data about a Intercom contact. + properties: + type: + type: string + nullable: true + description: Always location + example: location + country: + type: string + nullable: true + description: The country that the contact is located in + example: Ireland + region: + type: string + nullable: true + description: The overal region that the contact is located in + example: Dublin + city: + type: string + nullable: true + description: The city that the contact is located in + example: Dublin + contact_notes: + title: Contact notes + type: object + nullable: false + description: An object containing notes meta data about the notes that a contact + has. Up to 10 will be displayed here. Use the url to get more. + properties: + data: + type: array + description: This object represents the notes attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" + total_count: + type: integer + description: Int representing the total number of companyies attached to + this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_reference: + title: Contact Reference + type: object + description: reference to contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + contact_reply_base_request: + title: Contact Reply Base Object + type: object + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + attachment_urls: + title: Attachment URLs + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + required: + - message_type + - type + - body + contact_reply_conversation_request: + title: Contact Reply + oneOf: + - "$ref": "#/components/schemas/contact_reply_intercom_user_id_request" + - "$ref": "#/components/schemas/contact_reply_email_request" + - "$ref": "#/components/schemas/contact_reply_user_id_request" + contact_reply_email_request: + title: Email + type: object + description: Payload of the request to reply on behalf of a contact using their + `email` + properties: + email: + type: string + description: The email you have defined for the user. + attachment_files: + type: array + description: A list of files that will be added as attachments. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + required: + - email + contact_reply_intercom_user_id_request: + title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_files: + type: array + description: A list of files that will be added as attachments. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + required: + - intercom_user_id + contact_reply_ticket_email_request: + title: Email + type: object + description: Payload of the request to reply on behalf of a contact using their + `email` + properties: + email: + type: string + description: The email you have defined for the user. + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + required: + - email + contact_reply_ticket_intercom_user_id_request: + title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + required: + - intercom_user_id + contact_reply_ticket_request: + title: Contact Reply on ticket + oneOf: + - "$ref": "#/components/schemas/contact_reply_ticket_intercom_user_id_request" + - "$ref": "#/components/schemas/contact_reply_ticket_user_id_request" + - "$ref": "#/components/schemas/contact_reply_ticket_email_request" + contact_reply_ticket_user_id_request: + title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + user_id: + type: string + description: The external_id you have defined for the contact. + required: + - user_id + contact_reply_user_id_request: + title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_files: + type: array + description: A list of files that will be added as attachments. You can + include up to 10 files. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + maxItems: 10 + required: + - user_id + contact_segments: + title: Segments + type: object + description: A list of segments objects attached to a specific contact. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: Segment objects associated with the contact. + items: + "$ref": "#/components/schemas/segment" + contact_social_profiles: + title: Social Profile + type: object + nullable: false + description: An object containing social profiles that a contact has. + properties: + data: + type: array + description: A list of social profiles objects associated with the contact. + items: + "$ref": "#/components/schemas/social_profile" + contact_subscription_types: + title: Contact Subscription Types + type: object + nullable: false + description: An object containing Subscription Types meta data about the SubscriptionTypes + that a contact has. + properties: + data: + type: array + description: This object represents the subscriptions attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: Url to get more subscription type resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions" + total_count: + type: integer + description: Int representing the total number of subscription types attached + to this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_tags: + title: Contact Tags + type: object + nullable: true + description: An object containing tags meta data about the tags that a contact + has. Up to 10 will be displayed here. Use the url to get more. + properties: + data: + type: array + description: This object represents the tags attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: url to get more tag resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/tags" + total_count: + type: integer + description: Int representing the total number of tags attached to this + contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_unarchived: + title: Contact Unarchived + type: object + description: unarchived contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + archived: + type: boolean + description: Whether the contact is archived or not. + example: false + content_source: + title: Content Source + type: object + x-tags: + - AI Content Source + description: The content source used by AI Agent in the conversation. + properties: + content_type: + type: string + description: The type of the content source. + example: content_snippet + enum: + - file + - article + - external_content + - content_snippet + - workflow_connector_action + url: + type: string + description: The internal URL linking to the content source for teammates. + example: "/fin-ai-agent/content?content=content_snippet&id=3234924" + title: + type: string + description: The title of the content source. + example: My internal content snippet + locale: + type: string + description: The ISO 639 language code of the content source. + example: en + content_sources_list: + title: Content Source List + nullable: false + properties: + type: + type: string + enum: + - content_source.list + example: content_source.list + total_count: + type: integer + description: The total number of content sources used by AI Agent in the + conversation. + example: 1 + content_sources: + type: array + description: The content sources used by AI Agent in the conversation. + items: + "$ref": "#/components/schemas/content_source" + conversation: + title: Conversation + type: object + x-tags: + - Conversations + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + properties: + type: + type: string + description: Always conversation. + example: conversation + id: + type: string + description: The id representing the conversation. + example: '1295' + title: + type: string + nullable: true + description: The title given to the conversation. + example: Conversation Title + created_at: + type: integer + format: date-time + description: The time the conversation was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the conversation was updated. + example: 1663597260 + waiting_since: + type: integer + format: date-time + nullable: true + description: The last time a Contact responded to an Admin. In other words, + the time a customer started waiting for a response. Set to null if last + reply is from an Admin. + example: 1663597260 + snoozed_until: + type: integer + format: date-time + nullable: true + description: If set this is the time in the future when this conversation + will be marked as open. i.e. it will be in a snoozed state until this + time. i.e. it will be in a snoozed state until this time. + example: 1663597260 + open: + type: boolean + description: Indicates whether a conversation is open (true) or closed (false). + example: true + state: + type: string + enum: + - open + - closed + - snoozed + description: Can be set to "open", "closed" or "snoozed". + example: open + read: + type: boolean + description: Indicates whether a conversation has been read. + example: true + priority: + type: string + enum: + - priority + - not_priority + description: If marked as priority, it will return priority or else not_priority. + example: priority + admin_assignee_id: + type: integer + nullable: true + description: The id of the admin assigned to the conversation. If it's not + assigned to an admin it will return null. + example: 0 + team_assignee_id: + type: string + nullable: true + description: The id of the team assigned to the conversation. If it's not + assigned to a team it will return null. + example: '5017691' + tags: + "$ref": "#/components/schemas/tags" + conversation_rating: + "$ref": "#/components/schemas/conversation_rating" + source: + "$ref": "#/components/schemas/conversation_source" + contacts: + "$ref": "#/components/schemas/conversation_contacts" + teammates: + "$ref": "#/components/schemas/conversation_teammates" + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + first_contact_reply: + "$ref": "#/components/schemas/conversation_first_contact_reply" + sla_applied: + "$ref": "#/components/schemas/sla_applied" + statistics: + "$ref": "#/components/schemas/conversation_statistics" + conversation_parts: + "$ref": "#/components/schemas/conversation_parts" + linked_objects: + "$ref": "#/components/schemas/linked_object_list" + ai_agent_participated: + type: boolean + description: Indicates whether the AI Agent participated in the conversation. + example: true + ai_agent: + "$ref": "#/components/schemas/ai_agent" + nullable: true + conversation_attachment_files: + title: Conversation attachment files + type: object + description: Properties of the attachment files in a conversation part + properties: + content_type: + type: string + description: The content type of the file + example: application/json + data: + type: string + description: The base64 encoded file data. + example: ewogICJ0ZXN0IjogMQp9 + name: + type: string + description: The name of the file. + example: test.json + conversation_contacts: + title: Contacts + type: object + description: The list of contacts (users or leads) involved in this conversation. + This will only contain one customer unless more were added via the group conversation + feature. + properties: + type: + type: string + description: '' + enum: + - contact.list + example: contact.list + contacts: + type: array + description: The list of contacts (users or leads) involved in this conversation. + This will only contain one customer unless more were added via the group + conversation feature. + items: + "$ref": "#/components/schemas/contact_reference" + conversation_first_contact_reply: + title: First contact reply + type: object + nullable: true + description: An object containing information on the first users message. For + a contact initiated message this will represent the users original message. + properties: + created_at: + type: integer + format: date-time + description: '' + example: 1663597223 + type: + type: string + description: '' + example: conversation + url: + type: string + nullable: true + description: '' + example: https://developers.intercom.com/ + conversation_list: + title: Conversation List + type: object + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + properties: + type: + type: string + description: Always conversation.list + enum: + - conversation.list + example: conversation.list + conversations: + type: array + description: The list of conversation objects + items: + "$ref": "#/components/schemas/conversation" + total_count: + type: integer + description: A count of the total number of objects. + example: 12345 + pages: + "$ref": "#/components/schemas/cursor_pages" + conversation_part: + title: Conversation Part + type: object + description: A Conversation Part represents a message in the conversation. + properties: + type: + type: string + description: Always conversation_part + example: conversation_part + id: + type: string + description: The id representing the conversation part. + example: '3' + part_type: + type: string + description: The type of conversation part. + example: comment + body: + type: string + nullable: true + description: The message body, which may contain HTML. For Twitter, this + will show a generic message regarding why the body is obscured. + example: "

Okay!

" + created_at: + type: integer + format: date-time + description: The time the conversation part was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the conversation part was updated. + example: 1663597260 + notified_at: + type: integer + format: date-time + description: The time the user was notified with the conversation part. + example: 1663597260 + assigned_to: + "$ref": "#/components/schemas/reference" + nullable: true + description: The id of the admin that was assigned the conversation by this + conversation_part (null if there has been no change in assignment.) + author: + "$ref": "#/components/schemas/conversation_part_author" + attachments: + title: Conversation part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + external_id: + type: string + nullable: true + description: The external id of the conversation part + example: abcd1234 + redacted: + type: boolean + description: Whether or not the conversation part has been redacted. + example: false + conversation_part_author: + title: Conversation part author + type: object + description: The object who initiated the conversation, which can be a Contact, + Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. + For Twitter, this will be blank. + properties: + type: + type: string + description: The type of the author + example: admin + id: + type: string + description: The id of the author + example: '274' + name: + type: string + description: The name of the author + example: Operator + email: + type: string + format: email + description: The email of the author + example: operator+abcd1234@intercom.io + conversation_parts: + title: Conversation Parts + type: object + description: A list of Conversation Part objects for each part message in the + conversation. This is only returned when Retrieving a Conversation, and ignored + when Listing all Conversations. There is a limit of 500 parts. + properties: + type: + type: string + description: '' + enum: + - conversation_part.list + example: conversation_part.list + conversation_parts: + title: Conversation Parts + type: array + description: A list of Conversation Part objects for each part message in + the conversation. This is only returned when Retrieving a Conversation, + and ignored when Listing all Conversations. There is a limit of 500 parts. + items: + "$ref": "#/components/schemas/conversation_part" + total_count: + type: integer + description: '' + example: 2 + conversation_rating: + title: Conversation Rating + type: object + nullable: true + description: The Conversation Rating object which contains information on the + rating and/or remark added by a Contact and the Admin assigned to the conversation. + properties: + rating: + type: integer + description: The rating, between 1 and 5, for the conversation. + example: 5 + remark: + type: string + description: An optional field to add a remark to correspond to the number + rating + example: '' + created_at: + type: integer + format: date-time + description: The time the rating was requested in the conversation being + rated. + example: 1671028894 + contact: + "$ref": "#/components/schemas/contact_reference" + teammate: + "$ref": "#/components/schemas/reference" + conversation_source: + title: Conversation source + type: object + description: The Conversation Part that originated this conversation, which + can be Contact, Admin, Campaign, Automated or Operator initiated. + properties: + type: + type: string + description: This includes conversation, email, facebook, instagram, phone_call, + phone_switch, push, sms, twitter and whatsapp. + example: conversation + id: + type: string + description: The id representing the message. + example: '3' + delivered_as: + type: string + description: The conversation's initiation type. Possible values are customer_initiated, + campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), + automated (Series and other outbounds with dynamic audience message) and + admin_initiated (fixed audience message, ticket initiated by an admin, + group email). + example: operator_initiated + subject: + type: string + description: Optional. The message subject. For Twitter, this will show + a generic message regarding why the subject is obscured. + example: '' + body: + type: string + description: The message body, which may contain HTML. For Twitter, this + will show a generic message regarding why the body is obscured. + example: "

Hey there!

" + author: + "$ref": "#/components/schemas/conversation_part_author" + attachments: + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + url: + type: string + nullable: true + description: The URL where the conversation was started. For Twitter, Email, + and Bots, this will be blank. + example: + redacted: + type: boolean + description: Whether or not the source message has been redacted. Only applicable + for contact initiated messages. + example: false + conversation_statistics: + title: Conversation statistics + type: object + nullable: true + description: A Statistics object containing all information required for reporting, + with timestamps and calculated metrics. + properties: + type: + type: string + description: '' + example: conversation_statistics + time_to_assignment: + type: integer + description: Duration until last assignment before first admin reply. In + seconds. + example: 2310 + time_to_admin_reply: + type: integer + description: Duration until first admin reply. Subtracts out of business + hours. In seconds. + example: 2310 + time_to_first_close: + type: integer + description: Duration until conversation was closed first time. Subtracts + out of business hours. In seconds. + example: 2310 + time_to_last_close: + type: integer + description: Duration until conversation was closed last time. Subtracts + out of business hours. In seconds. + example: 2310 + median_time_to_reply: + type: integer + description: Median based on all admin replies after a contact reply. Subtracts + out of business hours. In seconds. + example: 2310 + first_contact_reply_at: + type: integer + format: date-time + description: Time of first text conversation part from a contact. + example: 1663597233 + first_assignment_at: + type: integer + format: date-time + description: Time of first assignment after first_contact_reply_at. + example: 1663597233 + first_admin_reply_at: + type: integer + format: date-time + description: Time of first admin reply after first_contact_reply_at. + example: 1663597233 + first_close_at: + type: integer + format: date-time + description: Time of first close after first_contact_reply_at. + example: 1663597233 + last_assignment_at: + type: integer + format: date-time + description: Time of last assignment after first_contact_reply_at. + example: 1663597233 + last_assignment_admin_reply_at: + type: integer + format: date-time + description: Time of first admin reply since most recent assignment. + example: 1663597233 + last_contact_reply_at: + type: integer + format: date-time + description: Time of the last conversation part from a contact. + example: 1663597233 + last_admin_reply_at: + type: integer + format: date-time + description: Time of the last conversation part from an admin. + example: 1663597233 + last_close_at: + type: integer + format: date-time + description: Time of the last conversation close. + example: 1663597233 + last_closed_by_id: + type: string + description: The last admin who closed the conversation. Returns a reference + to an Admin object. + example: c3po + count_reopens: + type: integer + description: Number of reopens after first_contact_reply_at. + example: 1 + count_assignments: + type: integer + description: Number of assignments after first_contact_reply_at. + example: 1 + count_conversation_parts: + type: integer + description: Total number of conversation parts. + example: 1 + conversation_teammates: + title: Conversation teammates + type: object + nullable: true + description: The list of teammates who participated in the conversation (wrote + at least one conversation part). + properties: + type: + type: string + description: The type of the object - `admin.list`. + example: admin.list + teammates: + type: array + description: The list of teammates who participated in the conversation + (wrote at least one conversation part). + items: + "$ref": "#/components/schemas/reference" + convert_conversation_to_ticket_request: + description: You can convert a Conversation to a Ticket + type: object + title: Convert Ticket Request Payload + properties: + ticket_type_id: + type: string + description: The ID of the type of ticket you want to convert the conversation + to + example: '1234' + attributes: + "$ref": "#/components/schemas/ticket_request_custom_attributes" + required: + - ticket_type_id + convert_visitor_request: + description: You can merge a Visitor to a Contact of role type lead or user. + type: object + title: Convert Visitor Request Payload + properties: + type: + type: string + description: Represents the role of the Contact model. Accepts `lead` or + `user`. + example: user + user: + type: object + description: The unique identifiers retained after converting or merging. + properties: + id: + type: string + description: The unique identifier for the contact which is given by + Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + user_id: + type: string + description: A unique identifier for the contact which is given to Intercom, + which will be represented as external_id. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: The contact's email, retained by default if one is present. + example: winstonsmith@truth.org + anyOf: + - required: + - id + - required: + - user_id + visitor: + type: object + description: The unique identifiers to convert a single Visitor. + properties: + id: + type: string + description: The unique identifier for the contact which is given by + Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + user_id: + type: string + description: A unique identifier for the contact which is given to Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: The visitor's email. + example: winstonsmith@truth.org + anyOf: + - required: + - id + - required: + - user_id + - required: + - email + required: + - type + - user + - visitor + create_article_request: + description: You can create an Article + type: object + title: Create Article Request Payload + nullable: true + properties: + title: + type: string + description: The title of the article.For multilingual articles, this will + be the title of the default language's content. + example: Thanks for everything + description: + type: string + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Description of the Article + body: + type: string + description: The content of the article. For multilingual articles, this + will be the body of the default language's content. + example: "

This is the body in html

" + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: 1295 + state: + type: string + description: Whether the article will be `published` or will be a `draft`. + Defaults to draft. For multilingual articles, this will be the state of + the default language's content. + enum: + - published + - draft + example: draft + parent_id: + type: integer + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: 18 + parent_type: + type: string + description: The type of parent, which can either be a `collection` or `section`. + example: collection + translated_content: + "$ref": "#/components/schemas/article_translated_content" + required: + - title + - author_id + create_collection_request: + description: You can create a collection + type: object + title: Create Collection Request Payload + properties: + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: collection 51 + description: + type: string + description: The description of the collection. For multilingual collections, + this will be the description of the default language's content. + example: English description + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it will be + created as the first level collection. + example: '6871118' + help_center_id: + type: integer + nullable: true + description: The id of the help center where the collection will be created. + If `null` then it will be created in the default help center. + example: '123' + required: + - name + create_contact_request: + description: Payload to create a contact + type: object + title: Create Contact Request Payload + properties: + role: + type: string + description: The role of the contact. + external_id: + type: string + description: A unique identifier for the contact which is given to Intercom + email: + type: string + description: The contacts email + example: jdoe@example.com + phone: + type: string + nullable: true + description: The contacts phone + example: "+353871234567" + name: + type: string + nullable: true + description: The contacts name + example: John Doe + avatar: + type: string + nullable: true + description: An image URL containing the avatar of a contact + example: https://www.example.com/avatar_image.jpg + signed_up_at: + type: integer + format: date-time + nullable: true + description: The time specified for when a contact signed up + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: The time when the contact was last seen (either where the Intercom + Messenger was installed or when specified manually) + example: 1571672154 + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact + example: 123 + unsubscribed_from_emails: + type: boolean + nullable: true + description: Whether the contact is unsubscribed from emails + example: true + custom_attributes: + type: object + nullable: true + description: The custom attributes which are set for the contact + anyOf: + - required: + - email + title: Create contact with email + - required: + - external_id + title: Create contact with external_id + - required: + - role + title: Create contact with role + create_conversation_request: + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + type: object + title: Create Conversation Request Payload + properties: + from: + type: object + properties: + type: + type: string + enum: + - lead + - user + - contact + description: The role associated to the contact - user or lead. + example: user + id: + type: string + description: The identifier for the contact which is given by Intercom. + format: uuid + minLength: 24 + maxLength: 24 + example: 536e564f316c83104c000020 + required: + - type + - id + body: + type: string + description: The content of the message. HTML is not supported. + example: Hello + required: + - from + - body + create_data_attribute_request: + description: '' + type: object + title: Create Data Attribute Request + properties: + name: + type: string + description: The name of the data attribute. + example: My Data Attribute + model: + type: string + description: The model that the data attribute belongs to. + enum: + - contact + - company + example: contact + data_type: + type: string + description: The type of data stored for this attribute. + enum: + - string + - integer + - float + - boolean + - datetime + - date + example: string + description: + type: string + description: The readable description you see in the UI for the attribute. + example: My Data Attribute Description + options: + type: array + description: To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be `string`. + items: + type: string + example: + - option1 + - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + required: + - name + - model + - data_type + create_data_event_request: + description: '' + type: object + title: Create Data Event Request + properties: + event_name: + type: string + description: The name of the event that occurred. This is presented to your + App's admins when filtering and creating segments - a good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + created_at: + type: integer + format: date-time + description: The time the event occurred as a UTC Unix timestamp + example: 1671028894 + user_id: + type: string + description: Your identifier for the user. + example: '314159' + id: + type: string + description: The unique identifier for the contact (lead or user) which + is given by Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: An email address for your user. An email should only be used + where your application uses email to uniquely identify users. + example: frodo.baggins@example.com + metadata: + type: object + description: Optional metadata about the event. + additionalProperties: + type: string + example: + invite_code: ADDAFRIEND + anyOf: + - title: id required + required: + - event_name + - created_at + - id + - title: user_id required + required: + - event_name + - created_at + - user_id + - title: email required + required: + - event_name + - created_at + - email + create_data_event_summaries_request: + description: You can send a list of event summaries for a user. Each event summary + should contain the event name, the time the event occurred, and the number + of times the event occurred. The event name should be a past tense "verb-noun" + combination, to improve readability, for example `updated-plan`. + type: object + title: Create Data Event Summaries Request + properties: + user_id: + type: string + description: Your identifier for the user. + example: '314159' + event_summaries: + type: object + description: A list of event summaries for the user. Each event summary + should contain the event name, the time the event occurred, and the number + of times the event occurred. The event name should be a past tense 'verb-noun' + combination, to improve readability, for example `updated-plan`. + properties: + event_name: + type: string + description: The name of the event that occurred. A good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + count: + type: integer + description: The number of times the event occurred. + example: 1 + first: + type: integer + format: date-time + description: The first time the event was sent + example: 1671028894 + last: + type: integer + format: date-time + description: The last time the event was sent + example: 1671028894 + create_data_exports_request: + description: Request for creating a data export + type: object + title: Create Data Export Request + properties: + created_at_after: + type: integer + description: The start date that you request data for. It must be formatted + as a unix timestamp. + example: 1527811200 + created_at_before: + type: integer + description: The end date that you request data for. It must be formatted + as a unix timestamp. + example: 1527811200 + required: + - created_at_after + - created_at_before + create_message_request: + description: You can create a message + type: object + title: Create Message Request Payload + nullable: true + properties: + message_type: + type: string + description: 'The kind of message being created. Values: `in_app` or `email`.' + enum: + - in_app + - email + example: in_app + subject: + type: string + description: The title of the email. + example: Thanks for everything + body: + type: string + description: The content of the message. HTML and plaintext are supported. + example: Hello there + template: + type: string + description: The style of the outgoing message. Possible values `plain` + or `personal`. + example: plain + from: + type: object + description: The sender of the message. If not provided, the default sender + will be used. + properties: + type: + type: string + description: Always `admin`. + enum: + - admin + example: admin + id: + type: integer + description: The identifier for the admin which is given by Intercom. + example: 394051 + required: + - type + - id + to: + type: object + description: The sender of the message. If not provided, the default sender + will be used. + properties: + type: + type: string + description: The role associated to the contact - `user` or `lead`. + enum: + - user + - lead + example: user + id: + type: string + description: The identifier for the contact which is given by Intercom. + example: 536e564f316c83104c000020 + required: + - type + - id + created_at: + type: integer + description: The time the message was created. If not provided, the current + time will be used. + example: 1590000000 + create_conversation_without_contact_reply: + type: boolean + description: Whether a conversation should be opened in the inbox for the + message without the contact replying. Defaults to false if not provided. + default: false + example: true + anyOf: + - title: 'message_type: `email`.' + required: + - message_type + - subject + - body + - template + - from + - to + - title: 'message_type: `inapp`.' + required: + - message_type + - body + - from + - to + create_or_update_company_request: + type: object + title: Create Or Update Company Request Payload + description: You can create or update a Company + nullable: true + properties: + name: + type: string + description: The name of the Company + example: Intercom + company_id: + type: string + description: The company id you have defined for the company. Can't be updated + example: 625e90fc55ab113b6d92175f + plan: + type: string + description: The name of the plan you have associated with the company. + example: Enterprise + size: + type: integer + description: The number of employees in this company. + example: '100' + website: + type: string + description: The URL for this company's website. Please note that the value + specified here is not validated. Accepts any string. + example: https://www.example.com + industry: + type: string + description: The industry that this company operates in. + example: Manufacturing + custom_attributes: + type: object + description: A hash of key/value pairs containing any other data about the + company you want Intercom to store. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + remote_created_at: + type: integer + description: The time the company was created by you. + example: 1394531169 + monthly_spend: + type: integer + description: How much revenue the company generates for your business. Note + that this will truncate floats. i.e. it only allow for whole integers, + 155.98 will be truncated to 155. Note that this has an upper limit of + 2**31-1 or 2147483647.. + example: 1000 + create_or_update_tag_request: + description: You can create or update an existing tag. + type: object + title: Create or Update Tag Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found, or + the new name for the tag if this is an update request. Names are case + insensitive. + example: Independent + id: + type: string + description: The id of tag to updates. + example: '656452352' + required: + - name + create_phone_switch_request: + description: You can create an phone switch + type: object + title: Create Phone Switch Request Payload + nullable: true + properties: + phone: + type: string + description: Phone number in E.164 format, that will receive the SMS to + continue the conversation in the Messenger. + example: "+1 1234567890" + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + required: + - phone + create_ticket_reply_with_comment_request: + title: Create Ticket Reply Request Payload + oneOf: + - "$ref": "#/components/schemas/contact_reply_ticket_request" + - "$ref": "#/components/schemas/admin_reply_ticket_request" + create_ticket_request: + description: You can create a Ticket + type: object + title: Create Ticket Request Payload + properties: + ticket_type_id: + type: string + description: The ID of the type of ticket you want to create + example: '1234' + contacts: + type: array + description: The list of contacts (users or leads) affected by this ticket. + Currently only one is allowed + items: + type: object + oneOf: + - title: ID + properties: + id: + type: string + description: The identifier for the contact as given by Intercom. + required: + - id + - title: External ID + properties: + external_id: + type: string + description: The external_id you have defined for the contact who + is being added as a participant. + required: + - external_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being + added as a participant. If a contact with this email does not + exist, one will be created. + required: + - email + example: + - id: '1234' + company_id: + type: string + description: The ID of the company that the ticket is associated with. The + ID that you set upon company creation. + example: '1234' + created_at: + type: integer + description: The time the ticket was created. If not provided, the current + time will be used. + example: 1590000000 + ticket_attributes: + "$ref": "#/components/schemas/ticket_request_custom_attributes" + required: + - ticket_type_id + - contacts + create_ticket_type_attribute_request: + description: You can create a Ticket Type Attribute + type: object + title: Create Ticket Type Attribute Request Payload + properties: + name: + type: string + description: The name of the ticket type attribute + example: Bug Priority + description: + type: string + description: The description of the attribute presented to the teammate + or contact + example: Priority level of the bug + data_type: + type: string + description: The data type of the attribute + enum: + - string + - list + - integer + - decimal + - boolean + - datetime + - files + example: string + required_to_create: + type: boolean + description: Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible to teammates when creating + a ticket in Inbox. + default: true + example: true + visible_to_contacts: + type: boolean + description: Whether the attribute is visible to contacts when creating + a ticket in Messenger. + default: true + example: true + multiline: + type: boolean + description: Whether the attribute allows multiple lines of text (only applicable + to string attributes) + example: false + list_items: + type: string + description: A comma delimited list of items for the attribute value (only + applicable to list attributes) + example: Low Priority,Medium Priority,High Priority + allow_multiple_values: + type: boolean + description: Whether the attribute allows multiple files to be attached + to it (only applicable to file attributes) + example: false + required: + - name + - description + - data_type + create_ticket_type_request: + description: | + The request payload for creating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + type: object + title: Create Ticket Type Request Payload + nullable: true + properties: + name: + type: string + description: The name of the ticket type. + example: Bug + description: + type: string + description: The description of the ticket type. + example: Used for tracking bugs + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + icon: + type: string + description: The icon of the ticket type. + example: "\U0001F41E" + default: "\U0001F39F️" + is_internal: + type: boolean + description: Whether the tickets associated with this ticket type are intended + for internal use only or will be shared with customers. This is currently + a limited attribute. + example: false + default: false + required: + - name + cursor_pages: + title: Cursor based pages + type: object + description: | + Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. + A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed. + nullable: true + properties: + type: + type: string + description: the type of object `pages`. + example: pages + enum: + - pages + page: + type: integer + description: The current page + example: 1 + next: + "$ref": "#/components/schemas/starting_after_paging" + per_page: + type: integer + description: Number of results per page + example: 2 + total_pages: + type: integer + description: Total number of pages + example: 13 + custom_attributes: + title: Custom Attributes + type: object + description: An object containing the different custom attributes associated + to the conversation as key-value pairs. For relationship attributes the value + will be a list of custom object instance models. + additionalProperties: + anyOf: + - type: string + - "$ref": "#/components/schemas/custom_object_instance" + custom_object_instance: + title: Custom Object Instance + type: object + x-tags: + - Custom Object Instances + nullable: true + description: A Custom Object Instance represents an instance of a custom object + type. This allows you to create and set custom attributes to store data about + your customers that is not already captured by Intercom. The parent object + includes recommended default attributes and you can add your own custom attributes. + properties: + id: + type: string + description: The Intercom defined id representing the custom object instance. + example: 5a7a19e9f59ae20001d1c1e6 + external_id: + type: string + description: The id you have defined for the custom object instance. + example: 0001d1c1e65a7a19e9f59ae2 + type: + type: string + description: The identifier of the custom object type that defines the structure + of the custom object instance. + example: Order + custom_attributes: + type: object + description: The custom attributes you have set on the custom object instance. + additionalProperties: + type: string + customer_request: + type: object + nullable: true + oneOf: + - title: Intercom User ID + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + example: 6329bd9ffe4e2e91dac76188 + required: + - intercom_user_id + - title: User ID + properties: + user_id: + type: string + description: The external_id you have defined for the contact who is being + added as a participant. + example: 2e91dac761886329bd9ffe4e + required: + - user_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being added + as a participant. + example: sam.sung@example.com + required: + - email + data_attribute: + title: Data Attribute + type: object + x-tags: + - Data Attributes + description: Data Attributes are metadata used to describe your contact, company + and conversation models. These include standard and custom attributes. By + using the data attributes endpoint, you can get the global list of attributes + for your workspace, as well as create and archive custom attributes. + properties: + type: + type: string + description: Value is `data_attribute`. + enum: + - data_attribute + example: data_attribute + id: + type: integer + description: The unique identifier for the data attribute which is given + by Intercom. Only available for custom attributes. + example: 12878 + model: + type: string + description: Value is `contact` for user/lead attributes and `company` for + company attributes. + enum: + - contact + - company + example: contact + name: + type: string + description: Name of the attribute. + example: paid_subscriber + full_name: + type: string + description: Full name of the attribute. Should match the name unless it's + a nested attribute. We can split full_name on `.` to access nested user + object values. + example: custom_attributes.paid_subscriber + label: + type: string + description: Readable name of the attribute (i.e. name you see in the UI) + example: Paid Subscriber + description: + type: string + description: Readable description of the attribute. + example: Whether the user is a paid subscriber. + data_type: + type: string + description: The data type of the attribute. + enum: + - string + - integer + - float + - boolean + - date + example: boolean + options: + type: array + description: List of predefined options for attribute value. + items: + type: string + example: + - 'true' + - 'false' + api_writable: + type: boolean + description: Can this attribute be updated through API + example: true + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + ui_writable: + type: boolean + description: Can this attribute be updated in the UI + example: true + custom: + type: boolean + description: Set to true if this is a CDA + example: true + archived: + type: boolean + description: Is this attribute archived. (Only applicable to CDAs) + example: false + created_at: + type: integer + format: date-time + description: The time the attribute was created as a UTC Unix timestamp + example: 1671028894 + updated_at: + type: integer + format: date-time + description: The time the attribute was last updated as a UTC Unix timestamp + example: 1671028894 + admin_id: + type: string + description: Teammate who created the attribute. Only applicable to CDAs + example: '5712945' + data_attribute_list: + title: Data Attribute List + type: object + description: A list of all data attributes belonging to a workspace for contacts, + companies or conversations. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of data attributes + items: + "$ref": "#/components/schemas/data_attribute" + data_event: + title: Data Event + type: object + x-tags: + - Data Events + description: Data events are used to notify Intercom of changes to your data. + properties: + type: + type: string + description: The type of the object + enum: + - event + example: event + event_name: + type: string + description: The name of the event that occurred. This is presented to your + App's admins when filtering and creating segments - a good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + created_at: + type: integer + format: date-time + description: The time the event occurred as a UTC Unix timestamp + example: 1671028894 + user_id: + type: string + description: Your identifier for the user. + example: '314159' + id: + type: string + description: Your identifier for a lead or a user. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + intercom_user_id: + type: string + description: The Intercom identifier for the user. + example: 63a0979a5eeebeaf28dd56ba + email: + type: string + description: An email address for your user. An email should only be used + where your application uses email to uniquely identify users. + example: frodo.baggins@example.com + metadata: + type: object + description: Optional metadata about the event. + additionalProperties: + type: string + example: + invite_code: ADDAFRIEND + required: + - event_name + - created_at + data_event_list: + title: Data Event List + type: object + description: This will return a list of data events for the App. + properties: + type: + type: string + description: The type of the object + enum: + - event.list + example: event.list + events: + type: array + description: A list of data events + items: + "$ref": "#/components/schemas/data_event" + pages: + type: object + description: Pagination + properties: + next: + type: string + example: https://api.intercom.io/events?per_page=2&before=1389913941064&intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user" + since: + type: string + example: https://api.intercom.io/events?intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user&since=1389913941065 + data_event_summary: + title: Data Event Summary + type: object + description: This will return a summary of data events for the App. + properties: + type: + type: string + description: The type of the object + enum: + - event.summary + example: event.summary + email: + type: string + description: The email address of the user + example: Sam.Sung@example.com + intercom_user_id: + type: string + description: The Intercom user ID of the user + example: 63a0979a5eeebeaf28dd56ba + user_id: + type: string + description: The user ID of the user + example: 62b997f288e14803c5006932 + events: + type: array + description: A summary of data events + items: + "$ref": "#/components/schemas/data_event_summary_item" + data_event_summary_item: + title: Data Event Summary Item + type: object + description: This will return a summary of a data event for the App. + nullable: true + properties: + name: + type: string + description: The name of the event + example: placed-order + first: + type: string + description: The first time the event was sent + example: '2014-01-16T23:12:21.000+00:00' + last: + type: string + description: The last time the event was sent + example: '2014-01-16T23:12:21.000+00:00 ' + count: + type: integer + description: The number of times the event was sent + example: 1 + description: + type: string + description: The description of the event + example: A user placed an order + data_export: + title: Data Export + type: object + x-tags: + - Data Export + description: The data export api is used to view all message sent & viewed in + a given timeframe. + properties: + job_identfier: + type: string + description: The identifier for your job. + example: orzzsbd7hk67xyu + status: + type: string + enum: + - pending + - in_progress + - failed + - completed + - no_data + - canceled + description: The current state of your job. + example: pending + download_expires_at: + type: string + description: The time after which you will not be able to access the data. + example: '1674917488' + download_url: + type: string + description: The location where you can download your data. + example: https://api.intercom.test/download/messages/data/example + data_export_csv: + title: Data Export CSV + type: object + description: A CSV output file + properties: + user_id: + type: string + description: The user_id of the user who was sent the message. + user_external_id: + type: string + description: The external_user_id of the user who was sent the message + company_id: + type: string + description: The company ID of the user in relation to the message that + was sent. Will return -1 if no company is present. + email: + type: string + description: The users email who was sent the message. + name: + type: string + description: The full name of the user receiving the message + ruleset_id: + type: string + description: The id of the message. + content_id: + type: string + description: The specific content that was received. In an A/B test each + version has its own Content ID. + content_type: + type: string + description: Email, Chat, Post etc. + content_title: + type: string + description: The title of the content you see in your Intercom workspace. + ruleset_version_id: + type: string + description: As you edit content we record new versions. This ID can help + you determine which version of a piece of content that was received. + receipt_id: + type: string + description: ID for this receipt. Will be included with any related stats + in other files to identify this specific delivery of a message. + received_at: + type: integer + description: Timestamp for when the receipt was recorded. + series_id: + type: string + description: The id of the series that this content is part of. Will return + -1 if not part of a series. + series_title: + type: string + description: The title of the series that this content is part of. + node_id: + type: string + description: The id of the series node that this ruleset is associated with. + Each block in a series has a corresponding node_id. + first_reply: + type: integer + description: The first time a user replied to this message if the content + was able to receive replies. + first_completion: + type: integer + description: The first time a user completed this message if the content + was able to be completed e.g. Tours, Surveys. + first_series_completion: + type: integer + description: The first time the series this message was a part of was completed + by the user. + first_series_disengagement: + type: integer + description: The first time the series this message was a part of was disengaged + by the user. + first_series_exit: + type: integer + description: The first time the series this message was a part of was exited + by the user. + first_goal_success: + type: integer + description: The first time the user met this messages associated goal if + one exists. + first_open: + type: integer + description: The first time the user opened this message. + first_click: + type: integer + description: The first time the series the user clicked on a link within + this message. + first_dismisall: + type: integer + description: The first time the series the user dismissed this message. + first_unsubscribe: + type: integer + description: The first time the user unsubscribed from this message. + first_hard_bounce: + type: integer + description: The first time this message hard bounced for this user + deleted_article_object: + title: Deleted Article Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the article which you provided in + the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted. - article + enum: + - article + example: article + deleted: + type: boolean + description: Whether the article was deleted successfully or not. + example: true + deleted_collection_object: + title: Deleted Collection Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the collection which you provided + in the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted. - `collection` + enum: + - collection + example: collection + deleted: + type: boolean + description: Whether the collection was deleted successfully or not. + example: true + deleted_company_object: + title: Deleted Company Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the company which is given by Intercom. + example: 5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f + object: + type: string + description: The type of object which was deleted. - `company` + enum: + - company + example: company + deleted: + type: boolean + description: Whether the company was deleted successfully or not. + example: true + deleted_object: + title: Deleted Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the news item which you provided + in the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted - news-item. + enum: + - news-item + example: news-item + deleted: + type: boolean + description: Whether the news item was deleted successfully or not. + example: true + detach_contact_from_conversation_request: + properties: + admin_id: + type: string + description: The `id` of the admin who is performing the action. + example: '5017690' + required: + - admin_id + error: + type: object + title: Error + description: The API will return an Error List for a failed request, which will + contain one or more Error objects. + properties: + type: + type: string + description: The type is error.list + example: error.list + request_id: + type: string + nullable: true + format: uuid + description: '' + example: f93ecfa8-d08a-4325-8694-89aeb89c8f85 + errors: + type: array + description: An array of one or more error objects + items: + properties: + code: + type: string + description: A string indicating the kind of error, used to further + qualify the HTTP response code + example: unauthorized + message: + type: string + nullable: true + description: Optional. Human readable description of the error. + example: Access Token Invalid + field: + type: string + nullable: true + description: Optional. Used to identify a particular field or query + parameter that was in error. + example: email + required: + - code + required: + - type + - errors + file_attribute: + title: File + type: object + description: The value describing a file upload set for a custom attribute + properties: + type: + type: string + example: upload + name: + type: string + description: The name of the file + example: Screenshot.png + url: + type: string + description: The url of the file. This is a temporary URL and will expire + after 30 minutes. + example: https://intercom-attachments-1.com/.../Screenshot.png + content_type: + type: string + description: The type of file + example: image/png + filesize: + type: integer + description: The size of the file in bytes + example: 11308309 + width: + type: integer + description: The width of the file in pixels, if applicable + example: 3024 + height: + type: integer + description: The height of the file in pixels, if applicable + example: 1964 + group_content: + title: Group Content + type: object + description: The Content of a Group. + nullable: true + properties: + type: + type: string + description: The type of object - `group_content` . + enum: + - + - group_content + example: group_content + nullable: true + name: + type: string + description: The name of the collection or section. + example: Collection name + description: + type: string + description: The description of the collection. Only available for collections. + example: " Collection description" + group_translated_content: + title: Group Translated Content + type: object + description: The Translated Content of an Group. The keys are the locale codes + and the values are the translated content of the Group. + nullable: true + properties: + type: + type: string + description: The type of object - group_translated_content. + nullable: true + enum: + - + - group_translated_content + example: group_translated_content + ar: + description: The content of the group in Arabic + "$ref": "#/components/schemas/group_content" + bg: + description: The content of the group in Bulgarian + "$ref": "#/components/schemas/group_content" + bs: + description: The content of the group in Bosnian + "$ref": "#/components/schemas/group_content" + ca: + description: The content of the group in Catalan + "$ref": "#/components/schemas/group_content" + cs: + description: The content of the group in Czech + "$ref": "#/components/schemas/group_content" + da: + description: The content of the group in Danish + "$ref": "#/components/schemas/group_content" + de: + description: The content of the group in German + "$ref": "#/components/schemas/group_content" + el: + description: The content of the group in Greek + "$ref": "#/components/schemas/group_content" + en: + description: The content of the group in English + "$ref": "#/components/schemas/group_content" + es: + description: The content of the group in Spanish + "$ref": "#/components/schemas/group_content" + et: + description: The content of the group in Estonian + "$ref": "#/components/schemas/group_content" + fi: + description: The content of the group in Finnish + "$ref": "#/components/schemas/group_content" + fr: + description: The content of the group in French + "$ref": "#/components/schemas/group_content" + he: + description: The content of the group in Hebrew + "$ref": "#/components/schemas/group_content" + hr: + description: The content of the group in Croatian + "$ref": "#/components/schemas/group_content" + hu: + description: The content of the group in Hungarian + "$ref": "#/components/schemas/group_content" + id: + description: The content of the group in Indonesian + "$ref": "#/components/schemas/group_content" + it: + description: The content of the group in Italian + "$ref": "#/components/schemas/group_content" + ja: + description: The content of the group in Japanese + "$ref": "#/components/schemas/group_content" + ko: + description: The content of the group in Korean + "$ref": "#/components/schemas/group_content" + lt: + description: The content of the group in Lithuanian + "$ref": "#/components/schemas/group_content" + lv: + description: The content of the group in Latvian + "$ref": "#/components/schemas/group_content" + mn: + description: The content of the group in Mongolian + "$ref": "#/components/schemas/group_content" + nb: + description: The content of the group in Norwegian + "$ref": "#/components/schemas/group_content" + nl: + description: The content of the group in Dutch + "$ref": "#/components/schemas/group_content" + pl: + description: The content of the group in Polish + "$ref": "#/components/schemas/group_content" + pt: + description: The content of the group in Portuguese (Portugal) + "$ref": "#/components/schemas/group_content" + ro: + description: The content of the group in Romanian + "$ref": "#/components/schemas/group_content" + ru: + description: The content of the group in Russian + "$ref": "#/components/schemas/group_content" + sl: + description: The content of the group in Slovenian + "$ref": "#/components/schemas/group_content" + sr: + description: The content of the group in Serbian + "$ref": "#/components/schemas/group_content" + sv: + description: The content of the group in Swedish + "$ref": "#/components/schemas/group_content" + tr: + description: The content of the group in Turkish + "$ref": "#/components/schemas/group_content" + vi: + description: The content of the group in Vietnamese + "$ref": "#/components/schemas/group_content" + pt-BR: + description: The content of the group in Portuguese (Brazil) + "$ref": "#/components/schemas/group_content" + zh-CN: + description: The content of the group in Chinese (China) + "$ref": "#/components/schemas/group_content" + zh-TW: + description: The content of the group in Chinese (Taiwan) + "$ref": "#/components/schemas/group_content" + help_center: + title: Help Center + type: object + x-tags: + - Help Center + description: Help Centers contain collections + properties: + id: + type: string + description: The unique identifier for the Help Center which is given by + Intercom. + example: '123' + workspace_id: + type: string + description: The id of the workspace which the Help Center belongs to. + example: hfi1bx4l + created_at: + type: integer + format: date-time + description: The time when the Help Center was created. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the Help Center was last updated. + example: 1672928610 + identifier: + type: string + description: The identifier of the Help Center. This is used in the URL + of the Help Center. + example: intercom + website_turned_on: + type: boolean + description: Whether the Help Center is turned on or not. This is controlled + in your Help Center settings. + example: true + display_name: + type: string + description: The display name of the Help Center only seen by teammates. + example: Intercom Help Center + help_center_list: + title: Help Centers + type: object + x-tags: + - Help Center + description: A list of Help Centers belonging to the App + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + data: + type: array + description: An array of Help Center objects + items: + "$ref": "#/components/schemas/help_center" + intercom_version: + description: Intercom API version.
By default, it's equal to the version + set in the app package. + type: string + example: '2.11' + default: '2.11' + enum: + - '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 + linked_object: + title: Linked Object + type: object + description: A linked conversation or ticket. + properties: + type: + type: string + description: ticket or conversation + enum: + - ticket + - conversation + example: ticket + id: + type: string + description: The ID of the linked object + example: '7583' + category: + type: string + description: Category of the Linked Ticket Object. + enum: + - Customer + - Back-office + - Tracker + - + example: Customer + nullable: true + linked_object_list: + title: Linked Objects + type: object + description: An object containing metadata about linked conversations and linked + tickets. Up to 1000 can be returned. + properties: + type: + type: string + description: Always list. + enum: + - list + example: list + total_count: + type: integer + description: The total number of linked objects. + example: 100 + has_more: + type: boolean + description: Whether or not there are more linked objects than returned. + example: false + data: + type: array + description: An array containing the linked conversations and linked tickets. + items: + "$ref": "#/components/schemas/linked_object" + merge_contacts_request: + description: Merge contact data. + type: object + title: Merge contact data + properties: + from: + type: string + description: The unique identifier for the contact to merge away from. Must + be a lead. + example: 5d70dd30de4efd54f42fd526 + into: + type: string + description: The unique identifier for the contact to merge into. Must be + a user. + example: 5ba682d23d7cf92bef87bfd4 + message: + type: object + title: Message + x-tags: + - Messages + description: Message are how you reach out to contacts in Intercom. They are + created when an admin sends an outbound message to a contact. + properties: + type: + type: string + description: The type of the message + example: user_message + id: + type: string + description: The id representing the message. + example: '1488971108' + created_at: + type: integer + format: date-time + description: The time the conversation was created. + example: 1667560812 + subject: + type: string + description: 'The subject of the message. Only present if message_type: + email.' + example: Greetings + body: + type: string + description: The message body, which may contain HTML. + example: Hello + message_type: + type: string + enum: + - email + - inapp + - facebook + - twitter + description: The type of message that was sent. Can be email, inapp, facebook + or twitter. + example: inapp + conversation_id: + type: string + description: The associated conversation_id + example: '64619700005570' + required: + - type + - id + - created_at + - body + - message_type + multiple_filter_search_request: + title: Multiple Filter Search Request + description: Search using Intercoms Search APIs with more than one filter. + type: object + properties: + operator: + type: string + enum: + - AND + - OR + description: An operator to allow boolean inspection between multiple fields. + example: AND + value: + oneOf: + - type: array + description: Add mutiple filters. + title: multiple filter search request + items: + "$ref": "#/components/schemas/multiple_filter_search_request" + - type: array + description: Add a single filter field. + title: single filter search request + items: + "$ref": "#/components/schemas/single_filter_search_request" + news_item: + title: News Item + type: object + x-tags: + - News + description: A News Item is a content type in Intercom enabling you to announce + product updates, company news, promotions, events and more with your customers. + properties: + type: + type: string + description: The type of object. + enum: + - news-item + example: news-item + id: + type: string + description: The unique identifier for the news item which is given by Intercom. + example: '141' + workspace_id: + type: string + description: The id of the workspace which the news item belongs to. + example: t74hdn32 + title: + type: string + description: The title of the news item. + example: 'New feature: News Items' + body: + type: string + description: The news item body, which may contain HTML. + example: We are excited to announce the launch of News Items, a new content + type in Intercom enabling you to announce product updates, company news, + promotions, events and more with your customers. + sender_id: + type: integer + description: The id of the sender of the news item. Must be a teammate on + the workspace. + example: 123 + state: + type: string + description: News items will not be visible to your users in the assigned + newsfeeds until they are set live. + enum: + - draft + - live + example: live + newsfeed_assignments: + type: array + description: A list of newsfeed_assignments to assign to the specified newsfeed. + items: + "$ref": "#/components/schemas/newsfeed_assignment" + labels: + type: array + description: Label names displayed to users to categorize the news item. + items: + type: string + nullable: true + description: The label name. + example: Product Update + cover_image_url: + type: string + format: uri + nullable: true + description: URL of the image used as cover. Must have .jpg or .png extension. + example: https://example.com/cover.jpg + reactions: + type: array + description: Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + items: + type: string + nullable: true + description: The emoji reaction to the news item. + example: "\U0001F44D" + deliver_silently: + type: boolean + description: When set to true, the news item will appear in the messenger + newsfeed without showing a notification badge. + example: true + created_at: + type: integer + format: timestamp + description: Timestamp for when the news item was created. + example: 1610589632 + updated_at: + type: integer + format: timestamp + description: Timestamp for when the news item was last updated. + example: 1610589632 + news_item_request: + description: A News Item is a content type in Intercom enabling you to announce + product updates, company news, promotions, events and more with your customers. + type: object + title: Create News Item Request + properties: + title: + type: string + description: The title of the news item. + example: Halloween is here! + body: + type: string + description: The news item body, which may contain HTML. + example: "

New costumes in store for this spooky season

" + sender_id: + type: integer + description: The id of the sender of the news item. Must be a teammate on + the workspace. + example: 123 + state: + type: string + description: News items will not be visible to your users in the assigned + newsfeeds until they are set live. + enum: + - draft + - live + example: live + deliver_silently: + type: boolean + description: When set to `true`, the news item will appear in the messenger + newsfeed without showing a notification badge. + example: true + labels: + type: array + description: Label names displayed to users to categorize the news item. + items: + type: string + example: + - Product + - Update + - New + reactions: + type: array + description: Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + items: + type: string + nullable: true + example: + - "\U0001F606" + - "\U0001F605" + newsfeed_assignments: + type: array + description: A list of newsfeed_assignments to assign to the specified newsfeed. + items: + "$ref": "#/components/schemas/newsfeed_assignment" + required: + - title + - sender_id + newsfeed: + title: Newsfeed + type: object + x-tags: + - News + description: | + A newsfeed is a collection of news items, targeted to a specific audience. + + Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. + properties: + id: + type: string + description: The unique identifier for the newsfeed which is given by Intercom. + example: '12312' + type: + type: string + description: The type of object. + enum: + - newsfeed + example: newsfeed + name: + type: string + description: The name of the newsfeed. This name will never be visible to + your users. + example: My Newsfeed + created_at: + type: integer + format: timestamp + description: Timestamp for when the newsfeed was created. + example: 1674917488 + updated_at: + type: integer + format: timestamp + description: Timestamp for when the newsfeed was last updated. + example: 1674917488 + newsfeed_assignment: + title: Newsfeed Assignment + type: object + x-tags: + - News + description: Assigns a news item to a newsfeed. + properties: + newsfeed_id: + type: integer + description: The unique identifier for the newsfeed which is given by Intercom. + Publish dates cannot be in the future, to schedule news items use the + dedicated feature in app (see this article). + example: 198313 + published_at: + type: integer + format: timestamp + description: Publish date of the news item on the newsfeed, use this field + if you want to set a publish date in the past (e.g. when importing existing + news items). On write, this field will be ignored if the news item state + is "draft". + example: 1674917488 + note: + title: Note + type: object + x-tags: + - Notes + description: Notes allow you to annotate and comment on your contacts. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `note`. + example: note + id: + type: string + description: The id of the note. + example: '17495962' + created_at: + type: integer + format: timestamp + description: The time the note was created. + example: 1674589321 + contact: + type: object + description: Represents the contact that the note was created about. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `contact`. + id: + type: string + description: The id of the contact. + example: 214656d0c743eafcfde7f248 + author: + "$ref": "#/components/schemas/admin" + description: Optional. Represents the Admin that created the note. + body: + type: string + description: The body text of the note. + example: "

Text for the note.

" + note_list: + title: Paginated Response + type: object + description: A paginated list of notes associated with a contact. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `list`. + example: list + data: + type: array + description: An array of notes. + items: + "$ref": "#/components/schemas/note" + total_count: + type: integer + description: A count of the total number of notes. + example: 1 + pages: + "$ref": "#/components/schemas/cursor_pages" + open_conversation_request: + title: Open Conversation Request + type: object + description: Payload of the request to open a conversation + properties: + message_type: + type: string + enum: + - open + example: open + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '5017690' + required: + - message_type + - admin_id + pages_link: + title: Pagination Object + type: object + description: | + The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests. + + Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows. + properties: + type: + type: string + example: pages + enum: + - pages + page: + type: integer + example: 1 + next: + type: string + format: uri + description: A link to the next page of results. A response that does not + contain a next link does not have further data to fetch. + nullable: true + per_page: + type: integer + example: 50 + total_pages: + type: integer + example: 1 + paginated_response: + title: Paginated Response + type: object + description: Paginated Response + properties: + type: + type: string + description: The type of object + enum: + - list + - conversation.list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of objects. + example: 1 + data: + type: array + description: An array of Objects + items: + anyOf: + - "$ref": "#/components/schemas/news_item" + - "$ref": "#/components/schemas/newsfeed" + part_attachment: + title: Part attachment + type: object + description: The file attached to a part + properties: + type: + type: string + description: The type of attachment + example: upload + name: + type: string + description: The name of the attachment + example: example.png + url: + type: string + description: The URL of the attachment + example: https://picsum.photos/200/300 + content_type: + type: string + description: The content type of the attachment + example: image/png + filesize: + type: integer + description: The size of the attachment + example: 100 + width: + type: integer + description: The width of the attachment + example: 100 + height: + type: integer + description: The height of the attachment + example: 100 + phone_switch: + title: Phone Switch + type: object + description: Phone Switch Response + nullable: true + properties: + type: + type: string + description: '' + enum: + - phone_call_redirect + default: phone_call_redirect + example: phone_call_redirect + phone: + type: string + description: Phone number in E.164 format, that has received the SMS to + continue the conversation in the Messenger. + example: "+1 1234567890" + redact_conversation_request: + oneOf: + - title: Redact Conversation Part Request + type: object + description: Payload of the request to redact a conversation part + properties: + type: + type: string + enum: + - conversation_part + description: The type of resource being redacted. + example: conversation_part + conversation_id: + type: string + description: The id of the conversation. + example: '19894788788' + conversation_part_id: + type: string + description: The id of the conversation_part. + example: '19381789428' + required: + - type + - conversation_id + - conversation_part_id + - title: Redact Conversation Source Request + type: object + description: Payload of the request to redact a conversation source + properties: + type: + type: string + enum: + - source + description: The type of resource being redacted. + example: source + conversation_id: + type: string + description: The id of the conversation. + example: '19894788788' + source_id: + type: string + description: The id of the source. + example: '19894781231' + required: + - type + - conversation_id + - source_id + reference: + title: Reference + type: object + description: reference to another object + properties: + type: + type: string + description: '' + example: contact + id: + type: string + nullable: true + description: '' + example: 1a2b3c + reply_conversation_request: + oneOf: + - "$ref": "#/components/schemas/contact_reply_conversation_request" + - "$ref": "#/components/schemas/admin_reply_conversation_request" + search_request: + description: Search using Intercoms Search APIs. + type: object + title: Search data + properties: + query: + oneOf: + - "$ref": "#/components/schemas/single_filter_search_request" + title: Single filter search request + - "$ref": "#/components/schemas/multiple_filter_search_request" + title: multiple filter search request + pagination: + "$ref": "#/components/schemas/starting_after_paging" + required: + - query + segment: + title: Segment + type: object + x-tags: + - Segments + description: A segment is a group of your contacts defined by the rules that + you set. + properties: + type: + type: string + description: The type of object. + enum: + - segment + example: segment + id: + type: string + description: The unique identifier representing the segment. + example: 56203d253cba154d39010062 + name: + type: string + description: The name of the segment. + example: Active + created_at: + type: integer + description: The time the segment was created. + example: 1394621988 + updated_at: + type: integer + description: The time the segment was updated. + example: 1394622004 + person_type: + type: string + description: 'Type of the contact: contact (lead) or user.' + enum: + - contact + - user + example: contact + count: + type: integer + description: The number of items in the user segment. It's returned when + `include_count=true` is included in the request. + example: 3 + nullable: true + segment_list: + title: Segment List + type: object + description: This will return a list of Segment Objects. The result may also + have a pages object if the response is paginated. + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + example: segment.list + segments: + type: array + description: A list of Segment objects + items: + "$ref": "#/components/schemas/segment" + pages: + type: object + description: A pagination object, which may be empty, indicating no further + pages to fetch. + single_filter_search_request: + title: Single Filter Search Request + description: Search using Intercoms Search APIs with a single filter. + type: object + properties: + field: + type: string + description: The accepted field that you want to search on. + example: created_at + operator: + type: string + enum: + - "=" + - "!=" + - IN + - NIN + - "<" + - ">" + - "~" + - "!~" + - "^" + - "$" + description: The accepted operators you can use to define how you want to + search for the value. + example: ">" + value: + type: string + description: The value that you want to search on. + example: '73732934' + sla_applied: + title: Applied SLA + type: object + nullable: true + description: | + The SLA Applied object contains the details for which SLA has been applied to this conversation. + Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null. + properties: + type: + type: string + description: object type + example: conversation_sla_summary + sla_name: + type: string + description: The name of the SLA as given by the teammate when it was created. + example: '' + sla_status: + type: string + enum: + - hit + - missed + - cancelled + - active + description: |- + SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events. + example: hit + snooze_conversation_request: + title: Snooze Conversation Request + type: object + description: Payload of the request to snooze a conversation + properties: + message_type: + type: string + enum: + - snoozed + example: snoozed + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '5017691' + snoozed_until: + type: integer + format: timestamp + description: The time you want the conversation to reopen. + example: 1673609604 + required: + - message_type + - admin_id + - snoozed_until + social_profile: + title: Social Profile + type: object + description: A Social Profile allows you to label your contacts, companies, + and conversations and list them using that Social Profile. + properties: + type: + type: string + description: value is "social_profile" + example: social_profile + name: + type: string + description: The name of the Social media profile + example: Facebook + url: + type: string + format: uri + description: The name of the Social media profile + example: http://twitter.com/th1sland + starting_after_paging: + title: 'Pagination: Starting After' + type: object + nullable: true + properties: + per_page: + type: integer + description: The number of results to fetch per page. + example: 2 + starting_after: + type: string + description: The cursor to use in the next request to get the next page + of results. + nullable: true + example: your-cursor-from-response + subscription_type: + title: Subscription Types + type: object + x-tags: + - Subscription Types + description: A subscription type lets customers easily opt out of non-essential + communications without missing what's important to them. + properties: + type: + type: string + description: The type of the object - subscription + example: subscription + id: + type: string + description: The unique identifier representing the subscription type. + example: '123456' + state: + type: string + description: The state of the subscription type. + enum: + - live + - draft + - archived + example: live + default_translation: + "$ref": "#/components/schemas/translation" + translations: + type: array + description: An array of translations objects with the localised version + of the subscription type in each available locale within your translation + settings. + items: + "$ref": "#/components/schemas/translation" + consent_type: + type: string + description: Describes the type of consent. + enum: + - opt_out + - opt_in + example: opt_in + content_types: + type: array + description: The message types that this subscription supports - can contain + `email` or `sms_message`. + items: + type: string + enum: + - email + - sms_message + example: email + subscription_type_list: + title: Subscription Types + type: object + description: A list of subscription type objects. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of subscription type objects associated with the workspace + . + items: + "$ref": "#/components/schemas/subscription_type" + tag: + title: Tag + type: object + x-tags: + - Tags + description: A tag allows you to label your contacts, companies, and conversations + and list them using that tag. + properties: + type: + type: string + description: value is "tag" + example: tag + id: + type: string + description: The id of the tag + example: '123456' + name: + type: string + description: The name of the tag + example: Test tag + applied_at: + type: integer + format: date-time + description: The time when the tag was applied to the object + example: 1663597223 + applied_by: + "$ref": "#/components/schemas/reference" + tag_company_request: + description: You can tag a single company or a list of companies. + type: object + title: Tag Company Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found. + example: Independent + companies: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + description: The id or company_id of the company can be passed as input + parameters. + required: + - name + - companies + tag_list: + title: Tags + type: object + description: A list of tags objects in the workspace. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of tags objects associated with the workspace . + items: + "$ref": "#/components/schemas/tag" + tag_multiple_users_request: + description: You can tag a list of users. + type: object + title: Tag Users Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found. + example: Independent + users: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the user. + example: 5f7f0d217289f8d2f4262080 + required: + - name + - users + tags: + title: Tags + type: object + description: A list of tags objects associated with a conversation + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + example: tag.list + tags: + type: array + description: A list of tags objects associated with the conversation. + items: + "$ref": "#/components/schemas/tag" + team: + title: Team + type: object + x-tags: + - Teams + description: Teams are groups of admins in Intercom. + properties: + type: + type: string + description: Value is always "team" + example: team + id: + type: string + description: The id of the team + example: '814865' + name: + type: string + description: The name of the team + example: Example Team + admin_ids: + type: array + description: The list of admin IDs that are a part of the team. + example: + - 493881 + items: + type: integer + admin_priority_level: + "$ref": "#/components/schemas/admin_priority_level" + team_list: + title: Team List + type: object + description: This will return a list of team objects for the App. + properties: + type: + type: string + description: The type of the object + enum: + - team.list + example: team.list + teams: + type: array + description: A list of team objects + items: + "$ref": "#/components/schemas/team" + team_priority_level: + title: Team Priority Level + type: object + nullable: true + description: Admin priority levels for teams + properties: + primary_team_ids: + type: array + description: The primary team ids for the team + nullable: true + example: + - 814865 + items: + type: integer + secondary_team_ids: + type: array + description: The secondary team ids for the team + nullable: true + example: + - 493881 + items: + type: integer + ticket: + title: Ticket + type: object + x-tags: + - Tickets + description: Tickets are how you track requests from your users. + nullable: true + properties: + type: + type: string + description: Always ticket + enum: + - ticket + default: ticket + example: ticket + id: + type: string + description: The unique identifier for the ticket which is given by Intercom. + example: '1295' + ticket_id: + type: string + description: The ID of the Ticket used in the Intercom Inbox and Messenger. + Do not use ticket_id for API queries. + example: '1390' + category: + type: string + description: Category of the Ticket. + enum: + - Customer + - Back-office + - Tracker + example: Customer + ticket_attributes: + "$ref": "#/components/schemas/ticket_custom_attributes" + ticket_state: + type: string + description: The state the ticket is currently in + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + example: submitted + ticket_type: + "$ref": "#/components/schemas/ticket_type" + contacts: + "$ref": "#/components/schemas/ticket_contacts" + admin_assignee_id: + type: string + description: The id representing the admin assigned to the ticket. + example: '1295' + team_assignee_id: + type: string + description: The id representing the team assigned to the ticket. + example: '1295' + created_at: + type: integer + format: date-time + description: The time the ticket was created as a UTC Unix timestamp. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the ticket was updated as a UTC Unix timestamp. + example: 1663597260 + open: + type: boolean + description: Whether or not the ticket is open. If false, the ticket is + closed. + example: true + snoozed_until: + type: integer + format: date-time + description: The time the ticket will be snoozed until as a UTC Unix timestamp. + If null, the ticket is not currently snoozed. + example: 1663597260 + linked_objects: + "$ref": "#/components/schemas/linked_object_list" + ticket_parts: + "$ref": "#/components/schemas/ticket_parts" + is_shared: + type: boolean + description: Whether or not the ticket is shared with the customer. + example: true + ticket_state_internal_label: + type: string + description: The state the ticket is currently in, in a human readable form + - visible in Intercom + ticket_state_external_label: + type: string + description: The state the ticket is currently in, in a human readable form + - visible to customers, in the messenger, email and tickets portal. + ticket_contacts: + title: Contacts + type: object + x-tags: + - Tickets + description: The list of contacts affected by a ticket. + properties: + type: + type: string + description: always contact.list + enum: + - contact.list + example: contact.list + contacts: + type: array + description: The list of contacts affected by this ticket. + items: + "$ref": "#/components/schemas/contact_reference" + ticket_custom_attributes: + title: Ticket Attributes + type: object + description: An object containing the different attributes associated to the + ticket as key-value pairs. For the default title and description attributes, + the keys are `_default_title_` and `_default_description_`. + additionalProperties: + anyOf: + - type: string + nullable: true + - type: number + - type: boolean + - type: array + - "$ref": "#/components/schemas/file_attribute" + example: + _default_title_: Found a bug + _default_description_: The button's not working + ticket_list: + title: Ticket List + type: object + description: Tickets are how you track requests from your users. + properties: + type: + type: string + description: Always ticket.list + enum: + - ticket.list + example: ticket.list + tickets: + type: array + description: The list of ticket objects + items: + "$ref": "#/components/schemas/ticket" + total_count: + type: integer + description: A count of the total number of objects. + example: 12345 + pages: + "$ref": "#/components/schemas/cursor_pages" + ticket_part: + title: Ticket Part + type: object + x-tags: + - Tickets + description: A Ticket Part represents a message in the ticket. + properties: + type: + type: string + description: Always ticket_part + example: ticket_part + id: + type: string + description: The id representing the ticket part. + example: '3' + part_type: + type: string + description: The type of ticket part. + example: comment + body: + type: string + nullable: true + description: The message body, which may contain HTML. + example: "

Okay!

" + previous_ticket_state: + type: string + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + description: The previous state of the ticket. + example: submitted + ticket_state: + type: string + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + description: The state of the ticket. + example: submitted + created_at: + type: integer + format: date-time + description: The time the ticket part was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the ticket part was updated. + example: 1663597260 + assigned_to: + "$ref": "#/components/schemas/reference" + nullable: true + description: The id of the admin that was assigned the ticket by this ticket_part + (null if there has been no change in assignment.) + author: + "$ref": "#/components/schemas/ticket_part_author" + attachments: + title: Ticket part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + external_id: + type: string + nullable: true + description: The external id of the ticket part + example: abcd1234 + redacted: + type: boolean + description: Whether or not the ticket part has been redacted. + example: false + ticket_part_author: + title: Ticket part author + type: object + description: The author that wrote or triggered the part. Can be a bot, admin, + team or user. + properties: + type: + type: string + description: The type of the author + example: admin + enum: + - admin + - bot + - team + - user + id: + type: string + description: The id of the author + example: '274' + name: + type: string + nullable: true + description: The name of the author + example: Operator + email: + type: string + format: email + description: The email of the author + example: operator+abcd1234@intercom.io + ticket_parts: + title: Ticket Parts + type: object + description: A list of Ticket Part objects for each note and event in the ticket. + There is a limit of 500 parts. + properties: + type: + type: string + description: '' + enum: + - ticket_part.list + example: ticket_part.list + ticket_parts: + title: Tickt Parts + type: array + description: A list of Ticket Part objects for each ticket. There is a limit + of 500 parts. + items: + "$ref": "#/components/schemas/ticket_part" + total_count: + type: integer + description: '' + example: 2 + ticket_reply: + title: A Ticket Part representing a note, comment, or quick_reply on a ticket + type: object + description: A Ticket Part representing a note, comment, or quick_reply on a + ticket + properties: + type: + type: string + description: Always ticket_part + example: ticket_part + enum: + - ticket_part + id: + type: string + description: The id representing the part. + example: '3' + part_type: + type: string + description: Type of the part + example: note + enum: + - note + - comment + - quick_reply + body: + type: string + nullable: true + description: The message body, which may contain HTML. + example: "

Okay!

" + created_at: + type: integer + format: date-time + description: The time the note was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the note was updated. + example: 1663597260 + author: + "$ref": "#/components/schemas/ticket_part_author" + attachments: + title: Ticket part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + redacted: + type: boolean + description: Whether or not the ticket part has been redacted. + example: false + ticket_request_custom_attributes: + title: Ticket Attributes + type: object + description: The attributes set on the ticket. When setting the default title + and description attributes, the attribute keys that should be used are `_default_title_` + and `_default_description_`. When setting ticket type attributes of the list + attribute type, the key should be the attribute name and the value of the + attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). + For example, if the ticket type has an attribute called `priority` of type + `list`, the key should be `priority` and the value of the attribute should + be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`). + additionalProperties: + anyOf: + - type: string + nullable: true + - type: number + - type: boolean + - type: array + example: + _default_title_: Found a bug + _default_description_: The button is not working + ticket_type: + title: Ticket Type + type: object + x-tags: + - Tickets + description: A ticket type, used to define the data fields to be captured in + a ticket. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type`. + example: ticket_type + id: + type: string + description: The id representing the ticket type. + example: '1295' + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + name: + type: string + description: The name of the ticket type + example: Bug + description: + type: string + description: The description of the ticket type + example: A bug that has been reported. + icon: + type: string + description: The icon of the ticket type + example: "\U0001F41E" + workspace_id: + type: string + description: The id of the workspace that the ticket type belongs to. + example: ecahpwf5 + ticket_type_attributes: + "$ref": "#/components/schemas/ticket_type_attribute_list" + archived: + type: boolean + description: Whether the ticket type is archived or not. + example: false + created_at: + type: integer + format: timestamp + description: The date and time the ticket type was created. + updated_at: + type: integer + format: timestamp + description: The date and time the ticket type was last updated. + ticket_type_attribute: + title: Ticket Type Attribute + type: object + description: Ticket type attribute, used to define each data field to be captured + in a ticket. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type_attribute`. + example: ticket_type_attribute + id: + type: string + description: The id representing the ticket type attribute. + example: '1' + workspace_id: + type: string + description: The id of the workspace that the ticket type attribute belongs + to. + example: ecahpwf5 + name: + type: string + description: The name of the ticket type attribute + example: Title + description: + type: string + description: The description of the ticket type attribute + example: Bug title. + data_type: + type: string + description: 'The type of the data attribute (allowed values: "string list + integer decimal boolean datetime files")' + example: string + input_options: + type: object + description: Input options for the attribute + example: 'multiline: true' + order: + type: integer + description: The order of the attribute against other attributes + example: 1 + required_to_create: + type: boolean + description: Whether the attribute is required or not for teammates. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required or not for contacts. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible or not to teammates. + default: true + example: false + visible_to_contacts: + type: boolean + description: Whether the attribute is visible or not to contacts. + default: true + example: false + default: + type: boolean + description: Whether the attribute is built in or not. + example: true + ticket_type_id: + type: integer + description: The id of the ticket type that the attribute belongs to. + example: 42 + archived: + type: boolean + description: Whether the ticket type attribute is archived or not. + example: false + created_at: + type: integer + format: timestamp + description: The date and time the ticket type attribute was created. + updated_at: + type: integer + format: timestamp + description: The date and time the ticket type attribute was last updated. + ticket_type_attribute_list: + title: Ticket Type Attributes + type: object + description: A list of attributes associated with a given ticket type. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type_attributes.list`. + ticket_type_attributes: + type: array + description: A list of ticket type attributes associated with a given ticket + type. + items: + "$ref": "#/components/schemas/ticket_type_attribute" + ticket_type_list: + title: Ticket Types + type: object + description: A list of ticket types associated with a given workspace. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type.list`. + ticket_types: + type: array + description: A list of ticket_types associated with a given workspace. + items: + "$ref": "#/components/schemas/ticket_type" + translation: + title: Translation + type: object + description: A translation object contains the localised details of a subscription + type. + properties: + name: + type: string + description: The localised name of the subscription type. + example: Announcements + description: + type: string + description: The localised description of the subscription type. + example: Offers, product and feature announcements + locale: + type: string + description: The two character identifier for the language of the translation + object. + example: en + untag_company_request: + description: You can tag a single company or a list of companies. + type: object + title: Untag Company Request Payload + properties: + name: + type: string + description: The name of the tag which will be untagged from the company + example: Independent + companies: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + untag: + type: boolean + description: Always set to true + example: 'true' + description: The id or company_id of the company can be passed as input + parameters. + required: + - name + - companies + update_article_request: + description: You can Update an Article + type: object + title: Update Article Request Payload + nullable: true + properties: + title: + type: string + description: The title of the article.For multilingual articles, this will + be the title of the default language's content. + example: Thanks for everything + description: + type: string + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Description of the Article + body: + type: string + description: The content of the article. For multilingual articles, this + will be the body of the default language's content. + example: "

This is the body in html

" + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: 1295 + state: + type: string + description: Whether the article will be `published` or will be a `draft`. + Defaults to draft. For multilingual articles, this will be the state of + the default language's content. + enum: + - published + - draft + example: draft + parent_id: + type: string + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: '18' + parent_type: + type: string + description: The type of parent, which can either be a `collection` or `section`. + example: collection + translated_content: + "$ref": "#/components/schemas/article_translated_content" + update_collection_request: + description: You can update a collection + type: object + title: Update Collection Request Payload + properties: + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: collection 51 + description: + type: string + description: The description of the collection. For multilingual collections, + this will be the description of the default language's content. + example: English description + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it will be + updated as the first level collection. + example: '6871118' + update_contact_request: + description: You can update a contact + type: object + title: Update Contact Request Payload + properties: + role: + type: string + description: The role of the contact. + external_id: + type: string + description: A unique identifier for the contact which is given to Intercom + email: + type: string + description: The contacts email + example: jdoe@example.com + phone: + type: string + nullable: true + description: The contacts phone + example: "+353871234567" + name: + type: string + nullable: true + description: The contacts name + example: John Doe + avatar: + type: string + nullable: true + description: An image URL containing the avatar of a contact + example: https://www.example.com/avatar_image.jpg + signed_up_at: + type: integer + format: date-time + nullable: true + description: The time specified for when a contact signed up + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: The time when the contact was last seen (either where the Intercom + Messenger was installed or when specified manually) + example: 1571672154 + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact + example: 123 + unsubscribed_from_emails: + type: boolean + nullable: true + description: Whether the contact is unsubscribed from emails + example: true + custom_attributes: + type: object + nullable: true + description: The custom attributes which are set for the contact + update_conversation_request: + title: Update Conversation Request + type: object + description: Payload of the request to update a conversation + properties: + read: + type: boolean + description: Mark a conversation as read within Intercom. + example: true + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + update_data_attribute_request: + description: '' + type: object + title: Update Data Attribute Request + properties: + archived: + type: boolean + description: Whether the attribute is to be archived or not. + example: false + description: + type: string + description: The readable description you see in the UI for the attribute. + example: My Data Attribute Description + options: + type: array + description: To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be `string`. + items: + type: string + example: + - option1 + - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + update_ticket_request: + description: You can update a Ticket + type: object + title: Update Ticket Request Payload + properties: + ticket_attributes: + type: object + description: The attributes set on the ticket. + example: + _default_title_: example + _default_description_: having a problem + state: + type: string + enum: + - in_progress + - waiting_on_customer + - resolved + description: The state of the ticket. + example: submitted + open: + type: boolean + description: Specify if a ticket is open. Set to false to close a ticket. + Closing a ticket will also unsnooze it. + example: true + is_shared: + type: boolean + description: Specify whether the ticket is visible to users. + example: true + snoozed_until: + type: integer + format: timestamp + description: The time you want the ticket to reopen. + example: 1673609604 + assignment: + type: object + properties: + admin_id: + type: string + description: The ID of the admin performing the action. + example: '123' + assignee_id: + type: string + description: The ID of the admin or team to which the ticket is assigned. + Set this 0 to unassign it. + example: '123' + update_ticket_type_attribute_request: + description: You can update a Ticket Type Attribute + type: object + title: Update Ticket Type Attribute Request Payload + properties: + name: + type: string + description: The name of the ticket type attribute + example: Bug Priority + description: + type: string + description: The description of the attribute presented to the teammate + or contact + example: Priority level of the bug + required_to_create: + type: boolean + description: Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible to teammates when creating + a ticket in Inbox. + default: true + example: true + visible_to_contacts: + type: boolean + description: Whether the attribute is visible to contacts when creating + a ticket in Messenger. + default: true + example: true + multiline: + type: boolean + description: Whether the attribute allows multiple lines of text (only applicable + to string attributes) + example: false + list_items: + type: string + description: A comma delimited list of items for the attribute value (only + applicable to list attributes) + example: Low Priority,Medium Priority,High Priority + allow_multiple_values: + type: boolean + description: Whether the attribute allows multiple files to be attached + to it (only applicable to file attributes) + example: false + archived: + type: boolean + description: Whether the attribute should be archived and not shown during + creation of the ticket (it will still be present on previously created + tickets) + example: false + update_ticket_type_request: + description: | + The request payload for updating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + type: object + title: Update Ticket Type Request Payload + nullable: true + properties: + name: + type: string + description: The name of the ticket type. + example: Bug + description: + type: string + description: The description of the ticket type. + example: A bug has been occured + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + icon: + type: string + description: The icon of the ticket type. + example: "\U0001F41E" + default: "\U0001F39F️" + archived: + type: boolean + description: The archived status of the ticket type. + example: false + is_internal: + type: boolean + description: Whether the tickets associated with this ticket type are intended + for internal use only or will be shared with customers. This is currently + a limited attribute. + example: false + default: false + update_visitor_request: + description: Update an existing visitor. + type: object + title: Update Visitor Request Payload + properties: + id: + type: string + description: A unique identified for the visitor which is given by Intercom. + example: 8a88a590-e + user_id: + type: string + description: A unique identified for the visitor which is given by you. + example: '123' + name: + type: string + description: The visitor's name. + example: Christian Bale + custom_attributes: + type: object + description: The custom attributes which are set for the visitor. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + anyOf: + - required: + - id + - required: + - user_id + visitor: + title: Visitor + type: object + description: Visitors are useful for representing anonymous people that have + not yet been identified. They usually represent website visitors. Visitors + are not visible in Intercom platform. The Visitors resource provides methods + to fetch, update, convert and delete. + nullable: true + properties: + type: + type: string + description: Value is 'visitor' + default: visitor + example: visitor + id: + type: string + description: The Intercom defined id representing the Visitor. + example: 530370b477ad7120001d + user_id: + type: string + description: Automatically generated identifier for the Visitor. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + anonymous: + type: boolean + description: Identifies if this visitor is anonymous. + example: false + email: + type: string + format: email + description: The email of the visitor. + example: jane.doe@example.com + phone: + type: string + nullable: true + description: The phone number of the visitor. + example: 555-555-5555 + name: + type: string + nullable: true + description: The name of the visitor. + example: Jane Doe + pseudonym: + type: string + nullable: true + description: The pseudonym of the visitor. + example: Red Duck from Dublin + avatar: + type: object + properties: + type: + type: string + description: '' + default: avatar + example: avatar + image_url: + type: string + format: uri + nullable: true + description: This object represents the avatar associated with the visitor. + example: https://example.com/avatar.png + app_id: + type: string + description: The id of the app the visitor is associated with. + example: hfi1bx4l + companies: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - company.list + example: company.list + companies: + type: array + items: + "$ref": "#/components/schemas/company" + location_data: + type: object + properties: + type: + type: string + description: '' + default: location_data + example: location_data + city_name: + type: string + description: The city name of the visitor. + example: Dublin + continent_code: + type: string + description: The continent code of the visitor. + example: EU + country_code: + type: string + description: The country code of the visitor. + example: IRL + country_name: + type: string + description: The country name of the visitor. + example: Ireland + postal_code: + type: string + description: The postal code of the visitor. + example: D02 N960 + region_name: + type: string + description: The region name of the visitor. + example: Leinster + timezone: + type: string + description: The timezone of the visitor. + example: Europe/Dublin + las_request_at: + type: integer + description: The time the Lead last recorded making a request. + example: 1663597260 + created_at: + type: integer + description: The time the Visitor was added to Intercom. + example: 1663597223 + remote_created_at: + type: integer + description: The time the Visitor was added to Intercom. + example: 1663597223 + signed_up_at: + type: integer + description: The time the Visitor signed up for your product. + example: 1663597223 + updated_at: + type: integer + description: The last time the Visitor was updated. + example: 1663597260 + session_count: + type: integer + description: The number of sessions the Visitor has had. + example: 1 + social_profiles: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - social_profile.list + example: social_profile.list + social_profiles: + type: array + items: + type: string + owner_id: + type: string + nullable: true + description: The id of the admin that owns the Visitor. + example: '5169261' + unsubscribed_from_emails: + type: boolean + description: Whether the Visitor is unsubscribed from emails. + example: false + marked_email_as_spam: + type: boolean + description: Identifies if this visitor has marked an email as spam. + example: false + has_hard_bounced: + type: boolean + description: Identifies if this visitor has had a hard bounce. + example: false + tags: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + example: tag.list + tags: + type: array + items: + properties: + type: + type: string + description: The type of the object + enum: + - tag + example: tag + id: + type: string + description: The id of the tag. + example: '8482' + name: + type: string + description: The name of the tag. + example: tag_name + segments: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + example: segment.list + segments: + type: array + items: + type: string + custom_attributes: + type: object + description: The custom attributes you have set on the Visitor. + additionalProperties: + type: string + referrer: + type: string + nullable: true + description: The referer of the visitor. + example: https://www.google.com/ + utm_campaign: + type: string + nullable: true + description: The utm_campaign of the visitor. + example: intercom-link + utm_content: + type: string + nullable: true + description: The utm_content of the visitor. + example: banner + utm_medium: + type: string + nullable: true + description: The utm_medium of the visitor. + example: email + utm_source: + type: string + nullable: true + description: The utm_source of the visitor. + example: Intercom + utm_term: + type: string + nullable: true + description: The utm_term of the visitor. + example: messenger + do_not_track: + type: boolean + nullable: true + description: Identifies if this visitor has do not track enabled. + example: false + visitor_deleted_object: + title: Visitor Deleted Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the visitor which is given by Intercom. + example: 530370b477ad7120001d + type: + type: string + description: The type of object which was deleted + enum: + - visitor + example: visitor + user_id: + type: string + description: Automatically generated identifier for the Visitor. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + securitySchemes: + bearerAuth: + type: http + scheme: bearer +servers: +- url: https://api.intercom.io + description: The production API server +- url: https://api.eu.intercom.io + description: The european API server +- url: https://api.au.intercom.io + description: The australian API server +security: +- bearerAuth: [] +tags: +- name: Admins + description: Everything about your Admins +- name: Articles + description: Everything about your Articles +- name: Companies + description: Everything about your Companies +- name: Contacts + description: Everything about your contacts +- name: Conversations + description: Everything about your Conversations + externalDocs: + description: What is a conversation? + url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation +- name: Data Attributes + description: Everything about your Data Attributes +- name: Data Events + description: Everything about your Data Events +- name: Data Export + description: Everything about your Data Exports +- name: Help Center + description: Everything about your Help Center +- name: Messages + description: Everything about your messages +- name: News + description: Everything about your News + externalDocs: + description: News explained + url: https://www.intercom.com/help/en/articles/6362251-news-explained +- name: Notes + description: Everything about your Notes +- name: Segments + description: Everything about your Segments +- name: Subscription Types + description: Everything about subscription types +- name: Switch + description: Everything about Switch + externalDocs: + description: 'Meet Switch: from on hold to messaging in just a few taps' + url: https://www.intercom.com/switch +- name: Tags + description: Everything about tags +- name: Teams + description: Everything about your Teams +- name: Ticket Type Attributes + description: Everything about your ticket type attributes +- name: Ticket Types + description: Everything about your ticket types +- name: Tickets + description: Everything about your tickets +- name: Visitors + description: Everything about your Visitors \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/openapi-filter/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/openapi-filter/openapi.yml new file mode 100644 index 0000000000..d5b09adb2c --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/openapi-filter/openapi.yml @@ -0,0 +1,17297 @@ +--- +openapi: 3.0.1 +info: + title: Intercom API + version: '2.11' + description: The intercom API reference. + contact: + name: Intercom Developer Hub + url: https://developers.intercom.com + license: + name: MIT + url: https://spdx.org/licenses/MIT +paths: + "/me": + get: + summary: Identify an admin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Admins + operationId: identifyAdmin + description: "\nYou can view the currently authorised admin along with the embedded + app object (a \"workspace\" in legacy terminology).\n\n> \U0001F6A7 Single + Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for + your site, and you call the `/me` endpoint to identify the logged-in user, + you should not accept any sign-ins from users with unverified email addresses + as it poses a potential impersonation security risk.\n" + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin + id: '991267390' + email: admin1@email.com + name: Ciaran1 Lee + email_verified: true + app: + type: app + id_code: this_is_an_id1_that_should_be_at_least_40 + name: MyApp 1 + created_at: 1719492696 + secure: false + identity_verification: false + timezone: America/Los_Angeles + region: US + avatar: + type: avatar + image_url: https://static.intercomassets.com/assets/default-avatars/admins/128.png + has_inbox_seat: true + schema: + "$ref": "#/components/schemas/admin_with_app" + "/admins/{id}/away": + put: + summary: Set an admin to away + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given admin + schema: + type: integer + tags: + - Admins + operationId: setAwayAdmin + description: You can set an Admin as away for the Inbox. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin + id: '991267391' + name: Ciaran2 Lee + email: admin2@email.com + away_mode_enabled: true + away_mode_reassign: true + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin" + '404': + description: Admin not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 9818bd03-9cc6-4ab8-8e7c-20a45ac58e97 + errors: + - code: admin_not_found + message: Admin for admin_id not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 18722269-a019-46c4-87d7-50d0f6f8a990 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - away_mode_enabled + - away_mode_reassign + properties: + away_mode_enabled: + type: boolean + description: Set to "true" to change the status of the admin to + away. + example: true + default: true + away_mode_reassign: + type: boolean + description: Set to "true" to assign any new conversation replies + to your default inbox. + example: false + default: false + examples: + successful_response: + summary: Successful response + value: + away_mode_enabled: true + away_mode_reassign: true + admin_not_found: + summary: Admin not found + value: + away_mode_enabled: true + away_mode_reassign: true + unauthorized: + summary: Unauthorized + value: + away_mode_enabled: true + away_mode_reassign: true + "/admins/activity_logs": + get: + summary: List all activity logs + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: created_at_after + in: query + required: true + description: The start date that you request data for. It must be formatted + as a UNIX timestamp. + example: '1677253093' + schema: + type: string + - name: created_at_before + in: query + required: false + description: The end date that you request data for. It must be formatted + as a UNIX timestamp. + example: '1677861493' + schema: + type: string + tags: + - Admins + operationId: listActivityLogs + description: You can get a log of activities by all admins in an app. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: activity_log.list + pages: + type: pages + next: + page: 1 + per_page: 20 + total_pages: 1 + activity_logs: + - id: ddee3a18-0032-4061-b9b9-26230c3dd5f7 + performed_by: + type: admin + id: '991267395' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + message: + id: 123 + title: Initial message title + before: Initial message title + after: Eventual message title + created_at: 1719492702 + activity_type: message_state_change + activity_description: Ciaran5 Lee changed your Initial message + title message from Initial message title to Eventual message + title. + - id: 5eec951b-db7a-4b5b-add5-95ffc90969b6 + performed_by: + type: admin + id: '991267395' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1719492702 + activity_type: app_name_change + activity_description: Ciaran5 Lee changed your app name from + before to after. + schema: + "$ref": "#/components/schemas/activity_log_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 06d9eefd-2b3a-48f7-938a-5a10383a4ebf + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/admins": + get: + summary: List all admins + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Admins + operationId: listAdmins + description: You can fetch a list of admins for a given workspace. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin.list + admins: + - type: admin + email: admin7@email.com + id: '991267397' + name: Ciaran7 Lee + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4ba8121e-4a4a-4668-adb2-363c561f3c52 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/admins/{id}": + get: + summary: Retrieve an admin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given admin + example: 123 + schema: + type: integer + tags: + - Admins + operationId: retrieveAdmin + description: You can retrieve the details of a single admin. + responses: + '200': + description: Admin found + content: + application/json: + examples: + Admin found: + value: + type: admin + id: '991267399' + name: Ciaran9 Lee + email: admin9@email.com + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin" + '404': + description: Admin not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 989bdb0b-1e8c-46cc-8953-9733dad40562 + errors: + - code: admin_not_found + message: Admin not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 83978032-1473-4696-b755-b497d46a23cf + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/articles": + get: + summary: List all articles + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Articles + operationId: listArticles + description: "You can fetch a list of all articles by making a GET request to + `https://api.intercom.io/articles`.\n\n> \U0001F4D8 How are the articles sorted + and ordered?\n>\n> 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.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + type: pages + page: 1 + per_page: 25 + total_pages: 1 + total_count: 1 + data: + - id: '39' + type: article + workspace_id: this_is_an_id33_that_should_be_at_least_4 + parent_id: 143 + parent_type: collection + parent_ids: [] + title: This is the article title + description: '' + body: '' + author_id: 991267402 + state: published + created_at: 1719492707 + updated_at: 1719492707 + url: http://help-center.test/myapp-33/en/articles/39-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 86d69044-5966-428e-9a40-2b39fba3f823 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Articles + operationId: createArticle + description: You can create a new article by making a POST request to `https://api.intercom.io/articles`. + responses: + '200': + description: article created + content: + application/json: + examples: + article created: + value: + id: '42' + type: article + workspace_id: this_is_an_id37_that_should_be_at_least_4 + parent_id: 145 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: Thanks for everything + description: Description of the Article + body:

Body of the Article

+ author_id: 991267407 + state: published + created_at: 1719492710 + updated_at: 1719492710 + url: http://help-center.test/myapp-37/en/articles/42-thanks-for-everything + schema: + "$ref": "#/components/schemas/article" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: e0ea220d-8030-4e0c-9fa9-6b40e9ed4fbd + errors: + - code: parameter_not_found + message: author_id must be in the main body or default locale + translated_content object + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f223a1d9-5377-4337-92bb-00fb39157f11 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_article_request" + examples: + article_created: + summary: article created + value: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + author_id: 991267407 + state: 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: published + bad_request: + summary: Bad Request + value: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + state: published + "/articles/{id}": + get: + summary: Retrieve an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: retrieveArticle + description: You can fetch the details of a single article by making a GET request + to `https://api.intercom.io/articles/`. + responses: + '200': + description: Article found + content: + application/json: + examples: + Article found: + value: + id: '45' + type: article + workspace_id: this_is_an_id43_that_should_be_at_least_4 + parent_id: 148 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: This is the article title + description: '' + body: '' + author_id: 991267412 + state: published + created_at: 1719492712 + updated_at: 1719492712 + url: http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article" + '404': + description: Article not found + content: + application/json: + examples: + Article not found: + value: + type: error.list + request_id: 99c73902-e8ea-4872-b412-1d55ce4582fb + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 62ab4791-7e4d-4400-a56b-b06a0ce3ba1a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: updateArticle + description: You can update the details of a single article by making a PUT + request to `https://api.intercom.io/articles/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '48' + type: article + workspace_id: this_is_an_id49_that_should_be_at_least_4 + parent_id: 151 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: Christmas is here! + description: '' + body:

New gifts in store for the jolly season

+ author_id: 991267418 + state: published + created_at: 1719492714 + updated_at: 1719492714 + url: http://help-center.test/myapp-49/en/articles/48-christmas-is-here + schema: + "$ref": "#/components/schemas/article" + '404': + description: Article Not Found + content: + application/json: + examples: + Article Not Found: + value: + type: error.list + request_id: 891b6ff4-181f-4b98-861b-d34ef16bfc4b + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 15b4f214-c670-43d7-ad8f-648791fddf9b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_article_request" + examples: + successful: + summary: successful + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + article_not_found: + summary: Article Not Found + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + delete: + summary: Delete an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: deleteArticle + description: You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '51' + object: article + deleted: true + schema: + "$ref": "#/components/schemas/deleted_article_object" + '404': + description: Article Not Found + content: + application/json: + examples: + Article Not Found: + value: + type: error.list + request_id: 60da5f23-613c-4f84-84bd-e9dbd3d67187 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 85d43c53-f28f-4295-b937-9a43ea71d0c3 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/articles/search": + get: + summary: Search for articles + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: phrase + in: query + required: false + description: The phrase within your articles to search for. + example: Getting started + schema: + type: string + - name: state + in: query + required: false + description: The state of the Articles returned. One of `published`, `draft` + or `all`. + example: published + schema: + type: string + - name: help_center_id + in: query + required: false + description: The ID of the Help Center to search in. + example: 123 + schema: + type: integer + - name: highlight + in: query + required: false + description: Return a highlighted version of the matching content within your + articles. Refer to the response schema for more details. + example: false + schema: + type: boolean + tags: + - Articles + operationId: searchArticles + description: You can search for articles by making a GET request to `https://api.intercom.io/articles/search`. + responses: + '200': + description: Search successful + content: + application/json: + examples: + Search successful: + value: + type: list + total_count: 1 + data: + articles: + - id: '55' + type: article + workspace_id: this_is_an_id61_that_should_be_at_least_4 + parent_id: + parent_type: + parent_ids: [] + title: Title 1 + description: '' + body: '' + author_id: 991267431 + state: draft + created_at: 1719492719 + updated_at: 1719492719 + url: + highlights: [] + pages: + type: pages + page: 1 + total_pages: 1 + per_page: 10 + schema: + "$ref": "#/components/schemas/article_search_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 626c6766-ee1a-489d-b87a-230d9b980c7d + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/collections": + get: + summary: List all collections + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: listAllCollections + description: | + You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`. + + Collections 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 collections first. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - id: '159' + workspace_id: this_is_an_id65_that_should_be_at_least_4 + name: English collection title + url: http://help-center.test/myapp-65/collection-17 + order: 17 + created_at: 1719492720 + updated_at: 1719492720 + description: english collection description + icon: bookmark + parent_id: + help_center_id: 79 + - id: '160' + workspace_id: this_is_an_id65_that_should_be_at_least_4 + name: English section title + url: http://help-center.test/myapp-65/section-1 + order: 1 + created_at: 1719492720 + updated_at: 1719492720 + description: + icon: bookmark + parent_id: '159' + help_center_id: + total_count: 2 + pages: + type: pages + page: 1 + per_page: 20 + total_pages: 1 + schema: + "$ref": "#/components/schemas/collection_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ccedcb48-7d08-4cc9-bcff-0622f70daf74 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: createCollection + description: You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.` + responses: + '200': + description: collection created + content: + application/json: + examples: + collection created: + value: + id: '165' + workspace_id: this_is_an_id69_that_should_be_at_least_4 + name: Thanks for everything + url: http://help-center.test/myapp-69/ + order: 1 + created_at: 1719492721 + updated_at: 1719492721 + description: '' + icon: book-bookmark + parent_id: + help_center_id: 81 + schema: + "$ref": "#/components/schemas/collection" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: 1f4fd741-8681-4c21-911a-47d7bb39d080 + errors: + - code: parameter_not_found + message: Name is a required parameter. + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 8afa14e4-0e7c-4159-8aab-dfa3dcb6a8b4 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_collection_request" + examples: + collection_created: + summary: collection created + value: + name: Thanks for everything + bad_request: + summary: Bad Request + value: + description: Missing required parameter + "/help_center/collections/{id}": + get: + summary: Retrieve a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: retrieveCollection + description: You can fetch the details of a single collection by making a GET + request to `https://api.intercom.io/help_center/collections/`. + responses: + '200': + description: Collection found + content: + application/json: + examples: + Collection found: + value: + id: '170' + workspace_id: this_is_an_id75_that_should_be_at_least_4 + name: English collection title + url: http://help-center.test/myapp-75/collection-22 + order: 22 + created_at: 1719492723 + updated_at: 1719492723 + description: english collection description + icon: bookmark + parent_id: + help_center_id: 84 + schema: + "$ref": "#/components/schemas/collection" + '404': + description: Collection not found + content: + application/json: + examples: + Collection not found: + value: + type: error.list + request_id: 2970f0f3-7020-4382-8892-eac24818ca88 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: bf1acd76-8c6e-45f4-8dbe-54391843270a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: updateCollection + description: You can update the details of a single collection by making a PUT + request to `https://api.intercom.io/collections/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '176' + workspace_id: this_is_an_id81_that_should_be_at_least_4 + name: Update collection name + url: http://help-center.test/myapp-81/collection-25 + order: 25 + created_at: 1719492724 + updated_at: 1719492724 + description: english collection description + icon: folder + parent_id: + help_center_id: 87 + schema: + "$ref": "#/components/schemas/collection" + '404': + description: Collection Not Found + content: + application/json: + examples: + Collection Not Found: + value: + type: error.list + request_id: 35e7f185-f547-4ae1-a23d-afc9027fc5a6 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 67002700-07f8-4a56-a9bc-464254c3a5bd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_collection_request" + examples: + successful: + summary: successful + value: + name: Update collection name + collection_not_found: + summary: Collection Not Found + value: + name: Update collection name + delete: + summary: Delete a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: deleteCollection + description: You can delete a single collection by making a DELETE request to + `https://api.intercom.io/collections/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '182' + object: collection + deleted: true + schema: + "$ref": "#/components/schemas/deleted_collection_object" + '404': + description: collection Not Found + content: + application/json: + examples: + collection Not Found: + value: + type: error.list + request_id: a35712b4-90b6-47fb-843d-757d9fdd81e6 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e00bc89b-b9a9-4bc2-84a0-5c9d4710bfcf + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/help_centers/{id}": + get: + summary: Retrieve a Help Center + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: retrieveHelpCenter + description: You can fetch the details of a single Help Center by making a GET + request to `https://api.intercom.io/help_center/help_center/`. + responses: + '200': + description: Collection found + content: + application/json: + examples: + Collection found: + value: + id: '93' + workspace_id: this_is_an_id93_that_should_be_at_least_4 + created_at: 1719492727 + updated_at: 1719492727 + identifier: help-center-1 + website_turned_on: false + display_name: Intercom Help Center + schema: + "$ref": "#/components/schemas/help_center" + '404': + description: Collection not found + content: + application/json: + examples: + Collection not found: + value: + type: error.list + request_id: c6e7d3f6-8a46-460e-8264-e07c2e7302aa + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 794a475b-0155-40b2-a288-ba0d48fdbd3f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/help_centers": + get: + summary: List all Help Centers + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: listHelpCenters + description: You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`. + responses: + '200': + description: Help Centers found + content: + application/json: + examples: + Help Centers found: + value: + type: list + data: [] + schema: + "$ref": "#/components/schemas/help_center_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c96a4779-a06d-45bb-aa39-eb96c587c2c7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies": + post: + summary: Create or Update a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Companies + operationId: createOrUpdateCompany + description: | + You can create or update a company. + + Companies will be only visible in Intercom when there is at least one associated user. + + Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated. + + {% admonition type="attention" name="Using `company_id`" %} + You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: company_remote_id + id: 667d607c8a68186f43bafd1e + app_id: this_is_an_id116_that_should_be_at_least_ + name: my company + remote_created_at: 1374138000 + created_at: 1719492732 + updated_at: 1719492732 + monthly_spend: 0 + session_count: 0 + user_count: 0 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: + creation_source: api + schema: + "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: + errors: + - code: bad_request + message: bad 'test' parameter + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 9b0d6fb9-d2d7-4904-a13c-97557a802323 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_or_update_company_request" + examples: + successful: + summary: Successful + value: + company_id: company_remote_id + name: my company + remote_created_at: 1374138000 + bad_request: + summary: Bad Request + value: + test: invalid + get: + summary: Retrieve companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: name + in: query + required: false + description: The `name` of the company to filter by. + example: my company + schema: + type: string + - name: company_id + in: query + required: false + description: The `company_id` of the company to filter by. + example: '12345' + schema: + type: string + - name: tag_id + in: query + required: false + description: The `tag_id` of the company to filter by. + example: '678910' + schema: + type: string + - name: segment_id + in: query + required: false + description: The `segment_id` of the company to filter by. + example: '98765' + schema: + type: string + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to display per page. Defaults to 15 + example: 15 + schema: + type: integer + tags: + - Companies + operationId: retrieveCompany + description: | + You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + + You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 667d607e8a68186f43bafd26 + app_id: this_is_an_id122_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1719492734 + created_at: 1719492734 + updated_at: 1719492734 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 15 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/company_list" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: c97dd75f-a434-4c83-a8e8-c4d1887d6c48 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6ef54f1c-70a4-4779-b3a6-29e4fd65d9dd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}": + get: + summary: Retrieve a company by ID + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: RetrieveACompanyById + description: You can fetch a single company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d60808a68186f43bafd31 + app_id: this_is_an_id128_that_should_be_at_least_ + name: company1 + remote_created_at: 1719492736 + created_at: 1719492736 + updated_at: 1719492736 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: b49593ed-49a6-4497-8fb7-220ff74527f6 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c4e2fcb8-815e-4bee-80c7-9d5b1ab0f6fe + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: UpdateCompany + description: | + You can update a single company using the Intercom provisioned `id`. + + {% admonition type="attention" name="Using `company_id`" %} + When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d60828a68186f43bafd3b + app_id: this_is_an_id134_that_should_be_at_least_ + name: company2 + remote_created_at: 1719492738 + created_at: 1719492738 + updated_at: 1719492738 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: b1ce72df-630f-4925-b212-fca6e833eb8d + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3f26a216-ddff-4782-9529-514f5bad56ea + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: deleteCompany + description: You can delete a single company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 667d60848a68186f43bafd45 + object: company + deleted: true + schema: + "$ref": "#/components/schemas/deleted_company_object" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 35a9b551-331e-499e-a63f-20396bfd29f5 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0a1a5065-69fe-47a4-9804-4cb2347671ef + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}/contacts": + get: + summary: List attached contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + - Contacts + operationId: ListAttachedContacts + description: You can fetch a list of all contacts that belong to a company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 50 + total_pages: 0 + schema: + "$ref": "#/components/schemas/company_attached_contacts" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: a6381081-a166-4e8e-952d-38bb2cd1c2b4 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: fe20b681-f988-4154-bec9-a5087fe0842e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}/segments": + get: + summary: List attached segments for companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: ListAttachedSegmentsForCompanies + description: You can fetch a list of all segments that belong to a company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: [] + schema: + "$ref": "#/components/schemas/company_attached_segments" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 22add598-fd33-4c34-971f-cf215117aab3 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 66fcc654-48ed-4f53-824e-831b5c96c9dc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/list": + post: + summary: List all companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to return per page. Defaults to 15 + example: 15 + schema: + type: integer + - name: order + in: query + required: false + description: "`asc` or `desc`. Return the companies in ascending or descending + order. Defaults to desc" + example: desc + schema: + type: string + tags: + - Companies + operationId: listAllCompanies + description: | + You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. + + Note that the API does not include companies who have no associated users in list responses. + + When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 667d608a8a68186f43bafd61 + app_id: this_is_an_id158_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1719492746 + created_at: 1719492746 + updated_at: 1719492746 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 15 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/company_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6f8cb4ca-9a95-43bd-aee1-597b85d1d13f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/scroll": + get: + summary: Scroll over all companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: scroll_param + in: query + required: false + description: '' + schema: + type: string + tags: + - Companies + operationId: scrollOverAllCompanies + description: |2 + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + + - Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. + - If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail + - If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + + {% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. + {% /admonition %} + {% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 667d608b8a68186f43bafd67 + app_id: this_is_an_id162_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1719492747 + created_at: 1719492747 + updated_at: 1719492747 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + total_count: + scroll_param: 12d403b5-dc79-47b5-8ea1-01a5ac8cb6cc + schema: + "$ref": "#/components/schemas/company_scroll" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4b3ca8b1-8983-4fb8-abc5-b20a4ece5d32 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}/companies": + post: + summary: Attach a Contact to a Company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the contact which is given by Intercom + schema: + type: string + tags: + - Companies + - Contacts + operationId: attachContactToACompany + description: You can attach a company to a single contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d608d8a68186f43bafd70 + app_id: this_is_an_id166_that_should_be_at_least_ + name: company6 + remote_created_at: 1719492749 + created_at: 1719492749 + updated_at: 1719492749 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: 9297dcfc-1896-43a3-a3f9-131238422ed2 + errors: + - code: parameter_not_found + message: company not specified + schema: + "$ref": "#/components/schemas/error" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 32d121d8-fcbf-4c59-9c60-204f7d602f36 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 99739bbd-2dbe-4ce3-ae91-af23379b5cd7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + x-fern-property-name: companyId + type: string + description: The unique identifier for the company which is given + by Intercom + example: 58a430d35458202d41b1e65b + examples: + successful: + summary: Successful + value: + id: 667d608d8a68186f43bafd70 + bad_request: + summary: Bad Request + value: + company_not_found: + summary: Company Not Found + value: + id: '123' + get: + summary: List attached companies for contact + parameters: + - name: id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Companies + operationId: listCompaniesForAContact + description: You can fetch a list of companies that are associated to a contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: company + company_id: '1' + id: 667d60938a68186f43bafd91 + app_id: this_is_an_id182_that_should_be_at_least_ + name: company12 + remote_created_at: 1719492755 + created_at: 1719492755 + updated_at: 1719492755 + last_request_at: 1719319955 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 50 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/contact_attached_companies" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: b9d7374d-1780-4668-bb62-0e1ff9cdab45 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d211ec8c-df9b-420c-86df-23c27ad54bc5 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/companies/{id}": + delete: + summary: Detach a contact from a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + required: true + description: The unique identifier for the contact which is given by Intercom + example: 58a430d35458202d41b1e65b + schema: + type: string + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 58a430d35458202d41b1e65b + schema: + type: string + tags: + - Companies + - Contacts + operationId: detachContactFromACompany + description: You can detach a company from a single contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d60918a68186f43bafd80 + app_id: this_is_an_id174_that_should_be_at_least_ + name: company8 + remote_created_at: 1719492753 + created_at: 1719492753 + updated_at: 1719492753 + monthly_spend: 0 + session_count: 0 + user_count: 0 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Contact Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: cd4f1648-724c-45f0-b6e1-72a1bc6479ee + errors: + - code: company_not_found + message: Company Not Found + Contact Not Found: + value: + type: error.list + request_id: d316defc-0a2f-49e7-b8ff-4cb6ccf46c90 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d8c1ab2d-4044-4c4f-98f0-176860747112 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}/notes": + get: + summary: List all notes + parameters: + - name: id + in: path + required: true + description: The unique identifier of a contact. + schema: + type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Notes + - Contacts + operationId: listNotes + description: You can fetch a list of notes that are associated to a contact. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: list + data: + - type: note + id: '29' + created_at: 1718887958 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '28' + created_at: 1718801558 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '27' + created_at: 1718801558 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + total_count: 3 + pages: + type: pages + next: + page: 1 + per_page: 50 + total_pages: 1 + schema: + "$ref": "#/components/schemas/note_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: e93f90a6-4c85-4dbf-b063-96b649318371 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a note + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given contact. + example: '123' + schema: + type: integer + tags: + - Notes + - Contacts + operationId: createNote + description: You can add a note to a single contact. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: note + id: '34' + created_at: 1719492759 + contact: + type: contact + id: 667d60978a68186f43bafd9e + author: + type: admin + id: '991267493' + name: Ciaran103 Lee + email: admin103@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

Hello

" + schema: + "$ref": "#/components/schemas/note" + '404': + description: Contact not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: d7c69ce6-3195-46be-b2cb-0dce355d2919 + errors: + - code: not_found + message: Resource Not Found + Contact not found: + value: + type: error.list + request_id: 2e3bd274-9ac6-43c3-a419-bcc8e6a03a1d + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - body + properties: + body: + type: string + description: The text of the note. + example: New note + contact_id: + type: string + description: The unique identifier of a given contact. + example: '123' + admin_id: + type: string + description: The unique identifier of a given admin. + example: '123' + examples: + successful_response: + summary: Successful response + value: + contact_id: 667d60978a68186f43bafd9e + admin_id: 991267493 + body: Hello + admin_not_found: + summary: Admin not found + value: + contact_id: 667d60988a68186f43bafd9f + admin_id: 123 + body: Hello + contact_not_found: + summary: Contact not found + value: + contact_id: 123 + admin_id: 991267495 + body: Hello + "/contacts/{contact_id}/segments": + get: + summary: List attached segments for contact + parameters: + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Segments + operationId: listSegmentsForAContact + description: You can fetch a list of segments that are associated to a contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: segment + id: 667d60998a68186f43bafda1 + name: segment + created_at: 1719492761 + updated_at: 1719492761 + person_type: user + schema: + "$ref": "#/components/schemas/contact_segments" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 7d4ab1a9-5990-4338-b5d9-0f3f55f1acb7 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d2927c64-9c5a-4593-997b-381f8c2356ea + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/subscriptions": + get: + summary: List subscriptions for a contact + parameters: + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Subscription Types + operationId: listSubscriptionsForAContact + description: | + You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + This will return a list of Subscription Type objects that the contact is associated with. + + The data property will show a combined list of: + + 1.Opt-out subscription types that the user has opted-out from. + 2.Opt-in subscription types that the user has opted-in to receiving. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: subscription + id: '93' + state: live + consent_type: opt_out + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - email + - type: subscription + id: '95' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 3f481052-cf49-4b95-a492-734223865981 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 82a95655-569d-4e5d-b0d9-f8a6c7a379f3 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Add subscription to a contact + tags: + - Subscription Types + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: attachSubscriptionTypeToContact + description: | + You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + + 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. + + 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. + + This will return a subscription type model for the subscription type that was added to the contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: subscription + id: '108' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type" + '404': + description: Resource not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: cf0f6fd6-7c5e-492b-909d-f60b35eea1c4 + errors: + - code: not_found + message: User Not Found + Resource not found: + value: + type: error.list + request_id: 3f852f45-1a80-4ade-9bc6-72b377d2bbd8 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 377d162e-82a5-4148-a26f-29c9c760dadc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - consent_type + properties: + id: + type: string + description: The unique identifier for the subscription which is + given by Intercom + example: '37846' + consent_type: + type: string + description: The consent_type of a subscription, opt_out or opt_in. + example: opt_in + examples: + successful: + summary: Successful + value: + id: 108 + consent_type: opt_in + contact_not_found: + summary: Contact not found + value: + id: 112 + consent_type: opt_in + resource_not_found: + summary: Resource not found + value: + id: invalid_id + consent_type: opt_in + "/contacts/{contact_id}/subscriptions/{id}": + delete: + summary: Remove subscription from a contact + tags: + - Subscription Types + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the subscription type which is given + by Intercom + example: '37846' + required: true + schema: + type: string + operationId: detachSubscriptionTypeToContact + description: You can remove a specific subscription from a contact. This will + return a subscription type model for the subscription type that was removed + from the contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: subscription + id: '124' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type" + '404': + description: Resource not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 7bc429e4-e887-4f53-b69c-94e6e55d2125 + errors: + - code: not_found + message: User Not Found + Resource not found: + value: + type: error.list + request_id: 66ebc1f5-5e02-4584-8028-f2559a41e8df + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 99fba0c6-2252-4658-abd2-1d2ff16a508b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/tags": + get: + summary: List tags attached to a contact + tags: + - Contacts + - Tags + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: listTagsForAContact + description: You can fetch a list of all tags that are attached to a specific + contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: tag + id: '93' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 2b513026-b78c-4c67-b073-da0266f62cc7 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 97383559-0fb0-4084-8a9a-8e3407c46108 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Add tag to a contact + tags: + - Tags + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: attachTagToContact + description: You can tag a specific contact. This will return a tag object for + the tag that was added to the contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '94' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 1bbd7e4b-718e-46f4-b682-a429aea78f01 + errors: + - code: not_found + message: User Not Found + Tag not found: + value: + type: error.list + request_id: a1a28017-728a-423b-adc0-2705d375f533 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 63a2828f-107e-4d51-9398-a220b81a7bce + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + examples: + successful: + summary: successful + value: + id: 94 + contact_not_found: + summary: Contact not found + value: + id: 95 + tag_not_found: + summary: Tag not found + value: + id: '123' + "/contacts/{contact_id}/tags/{id}": + delete: + summary: Remove tag from a contact + tags: + - Tags + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string + operationId: detachTagFromContact + description: You can remove tag from a specific contact. This will return a + tag object for the tag that was removed from the contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '97' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 6f735483-c309-4e94-b9ab-143aedc0c691 + errors: + - code: not_found + message: User Not Found + Tag not found: + value: + type: error.list + request_id: 9e780671-29b3-4913-b4be-15234ea0bc6a + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e97d9f1b-8c9e-4caf-b473-3bce411c697e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}": + put: + summary: Update a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: UpdateContact + description: You can update an existing contact (ie. user or lead). + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60a88a68186f43bafdb8 + workspace_id: this_is_an_id248_that_should_be_at_least_ + external_id: '70' + role: user + email: joebloggs@intercom.io + phone: + name: joe bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492776 + updated_at: 1719492776 + signed_up_at: 1719492776 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b1b88e2d-938c-4a26-b65d-26ff65a0af36 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/update_contact_request" + examples: + successful: + summary: successful + value: + email: joebloggs@intercom.io + name: joe bloggs + get: + summary: Get a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: ShowContact + description: You can fetch the details of a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60a98a68186f43bafdb9 + workspace_id: this_is_an_id252_that_should_be_at_least_ + external_id: '70' + role: user + email: joe@bloggs.com + phone: + name: Joe Bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492777 + updated_at: 1719492777 + signed_up_at: 1719492777 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f70085f1-f655-43ee-9585-d2061b260fcd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + required: true + schema: + type: string + tags: + - Contacts + operationId: DeleteContact + description: You can delete a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 667d60aa8a68186f43bafdba + external_id: '70' + type: contact + deleted: true + schema: + "$ref": "#/components/schemas/contact_deleted" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0bce3945-d2ec-4b8e-a790-b16fd52d9f11 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/merge": + post: + summary: Merge a lead and a user + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: MergeContact + description: You can merge a contact with a `role` of `lead` into a contact + with a `role` of `user`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60ac8a68186f43bafdbc + workspace_id: this_is_an_id260_that_should_be_at_least_ + external_id: '70' + role: user + email: joe@bloggs.com + phone: + name: Joe Bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492780 + updated_at: 1719492780 + signed_up_at: 1719492780 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 57b64228-0e60-4e35-833d-39c4e4067dde + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/merge_contacts_request" + examples: + successful: + summary: successful + value: + from: 667d60ac8a68186f43bafdbb + into: 667d60ac8a68186f43bafdbc + "/contacts/search": + post: + summary: Search contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: SearchContacts + description: | + You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + + To search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`. + + This will accept a query object in the body which will define your filters in order to search for contacts. + + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + ### Contact Creation Delay + + If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiple's there can be: + * There's a limit of max 2 nested filters + * There's a limit of max 15 filters for each AND or OR group + + ### Searching for Timestamp Fields + + All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly. + + ### Accepted Fields + + Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + + | Field | Type | + | ---------------------------------- | ------------------------------ | + | id | String | + | role | String
Accepts user or lead | + | name | String | + | avatar | String | + | owner_id | Integer | + | email | String | + | email_domain | String | + | phone | String | + | formatted_phone | String | + | external_id | String | + | created_at | Date (UNIX Timestamp) | + | signed_up_at | Date (UNIX Timestamp) | + | updated_at | Date (UNIX Timestamp) | + | last_seen_at | Date (UNIX Timestamp) | + | last_contacted_at | Date (UNIX Timestamp) | + | last_replied_at | Date (UNIX Timestamp) | + | last_email_opened_at | Date (UNIX Timestamp) | + | last_email_clicked_at | Date (UNIX Timestamp) | + | language_override | String | + | browser | String | + | browser_language | String | + | os | String | + | location.country | String | + | location.region | String | + | location.city | String | + | unsubscribed_from_emails | Boolean | + | marked_email_as_spam | Boolean | + | has_hard_bounced | Boolean | + | ios_last_seen_at | Date (UNIX Timestamp) | + | ios_app_version | String | + | ios_device | String | + | ios_app_device | String | + | ios_os_version | String | + | ios_app_name | String | + | ios_sdk_version | String | + | android_last_seen_at | Date (UNIX Timestamp) | + | android_app_version | String | + | android_device | String | + | android_app_name | String | + | andoid_sdk_version | String | + | segment_id | String | + | tag_id | String | + | custom_attributes.{attribute_name} | String | + + ### Accepted Operators + + {% admonition type="attention" name="Searching based on `created_at`" %} + You cannot use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :------------------------------- | :--------------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In
Shortcut for `OR` queries
Values must be in Array | + | NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array | + | > | Integer
Date (UNIX Timestamp) | Greater than | + | < | Integer
Date (UNIX Timestamp) | Lower than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 5 + total_pages: 0 + schema: + "$ref": "#/components/schemas/contact_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 2b28c47b-8fa3-4e17-8fc1-6ba80f1cc844 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: created_at + operator: ">" + value: '1306054154' + pagination: + per_page: 5 + "/contacts": + get: + summary: List all contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: ListContacts + description: | + You can fetch a list of all contacts (ie. users or leads) in your workspace. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 10 + total_pages: 0 + schema: + "$ref": "#/components/schemas/contact_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d5bac7ff-7961-4fe5-8aed-6f1b031b38af + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: CreateContact + description: You can create a new contact (ie. user or lead). + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60b08a68186f43bafdbf + workspace_id: this_is_an_id272_that_should_be_at_least_ + external_id: + role: user + email: joebloggs@intercom.io + phone: + name: + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492784 + updated_at: 1719492784 + signed_up_at: + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c18ca0d4-ad2c-41e7-9a71-1df806f9c954 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/create_contact_request" + examples: + successful: + summary: successful + value: + email: joebloggs@intercom.io + "/contacts/{id}/archive": + post: + summary: Archive contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: ArchiveContact + description: You can archive a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 667d60b18a68186f43bafdc0 + external_id: '70' + type: contact + archived: true + schema: + "$ref": "#/components/schemas/contact_archived" + "/contacts/{id}/unarchive": + post: + summary: Unarchive contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: UnarchiveContact + description: You can unarchive a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 667d60b28a68186f43bafdc1 + external_id: '70' + type: contact + archived: false + schema: + "$ref": "#/components/schemas/contact_unarchived" + "/conversations/{conversation_id}/tags": + post: + summary: Add tag to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + description: conversation_id + example: '64619700005694' + required: true + schema: + type: string + tags: + - Tags + - Conversations + operationId: attachTagToConversation + description: You can tag a specific conversation. This will return a tag object + for the tag that was added to the conversation. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '99' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Conversation not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: 840d35aa-2414-402a-b3c6-763a410e0d16 + errors: + - code: not_found + message: Conversation not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 95cacea0-4744-4de8-a2bf-da4419f75732 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - admin_id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '780' + examples: + successful: + summary: successful + value: + id: 99 + admin_id: 991267526 + conversation_not_found: + summary: Conversation not found + value: + id: 100 + admin_id: 991267528 + "/conversations/{conversation_id}/tags/{id}": + delete: + summary: Remove tag from a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + description: conversation_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: id + example: '7522907' + required: true + schema: + type: string + tags: + - Tags + - Conversations + operationId: detachTagFromConversation + description: You can remove tag from a specific conversation. This will return + a tag object for the tag that was removed from the conversation. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '102' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: f78f63ba-911d-47b8-a389-b33e3ccbe77e + errors: + - code: not_found + message: Conversation not found + Tag not found: + value: + type: error.list + request_id: 0d00d069-2cf1-496f-b887-a4db74ee320d + errors: + - code: tag_not_found + message: Tag not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f083d6b1-e9d2-43b3-86df-67539007fc3e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - admin_id + properties: + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '123' + examples: + successful: + summary: successful + value: + admin_id: 991267530 + conversation_not_found: + summary: Conversation not found + value: + admin_id: 991267532 + tag_not_found: + summary: Tag not found + value: + admin_id: 991267533 + "/conversations": + get: + summary: List all conversations + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: per_page + in: query + schema: + type: integer + default: 20 + maximum: 150 + required: false + description: How many results per page + - name: starting_after + in: query + required: false + description: String used to get the next page of conversations. + schema: + type: string + tags: + - Conversations + operationId: listConversations + description: | + You can fetch a list of all conversations. + + You can optionally request the result page size and the cursor to start after to fetch the result. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: conversation.list + pages: + type: pages + page: 1 + per_page: 20 + total_pages: 1 + total_count: 1 + conversations: + - type: conversation + id: '335' + created_at: 1719492795 + updated_at: 1719492795 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918241' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267536' + name: Ciaran143 Lee + email: admin143@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60bb8a68186f43bafdc5 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 18db64a8-7a08-4967-9ec6-0416178306f9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: a91eac55-8d70-454d-a01d-c6bb875aaa35 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + post: + summary: Creates a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: createConversation + description: |+ + You can create a conversation that has been initiated by a contact (ie. user or lead). + The conversation can be an in-app message only. + + {% admonition type="info" name="Sending for visitors" %} + You can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`. + This visitor will be automatically converted to a contact with a lead role once the conversation is created. + {% /admonition %} + + This will return the Message model that has been created. + + responses: + '200': + description: conversation created + content: + application/json: + examples: + conversation created: + value: + type: user_message + id: '403918251' + created_at: 1719492819 + body: Hello there + message_type: inapp + conversation_id: '363' + schema: + "$ref": "#/components/schemas/message" + '404': + description: Contact Not Found + content: + application/json: + examples: + Contact Not Found: + value: + type: error.list + request_id: ed0ab0c5-57b8-4413-a7a9-bbc134b40876 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: af9757fc-4e1d-463c-ac9d-788503f04a95 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: c7a35217-6720-48bd-a2ae-c2acb5adea30 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_conversation_request" + examples: + conversation_created: + summary: conversation created + value: + from: + type: user + id: 667d60d18a68186f43bafddd + body: Hello there + contact_not_found: + summary: Contact Not Found + value: + from: + type: user + id: 123_doesnt_exist + body: Hello there + "/conversations/{id}": + get: + summary: Retrieve a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + - name: display_as + in: query + required: false + description: Set to plaintext to retrieve conversation messages in plain text. + example: plaintext + schema: + type: string + tags: + - Conversations + operationId: retrieveConversation + description: |2 + + You can fetch the details of a single conversation. + + This will return a single Conversation model with all its conversation parts. + + {% admonition type="warning" name="Hard limit of 500 parts" %} + The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + {% /admonition %} + + For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). + responses: + '200': + description: conversation found + content: + application/json: + examples: + conversation found: + value: + type: conversation + id: '367' + created_at: 1719492825 + updated_at: 1719492825 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918255' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267553' + name: Ciaran153 Lee + email: admin153@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60d88a68186f43bafde1 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: [] + total_count: 0 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 978c1e65-1eba-4995-9acb-ff8f33b283e3 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b1f6adfd-f7da-4880-8d11-d842235126ae + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: c7b0a10f-d482-4352-8d7b-1ad26b902473 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + - name: display_as + in: query + required: false + description: Set to plaintext to retrieve conversation messages in plain text. + example: plaintext + schema: + type: string + tags: + - Conversations + operationId: updateConversation + description: |2+ + + You can update an existing conversation. + + {% admonition type="info" name="Replying and other actions" %} + If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + {% /admonition %} + + responses: + '200': + description: conversation found + content: + application/json: + examples: + conversation found: + value: + type: conversation + id: '371' + created_at: 1719492832 + updated_at: 1719492834 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918259' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267561' + name: Ciaran157 Lee + email: admin157@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60e08a68186f43bafde5 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: + issue_type: Billing + priority: High + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '96' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + assigned_to: + author: + id: '991267562' + type: bot + name: Operator + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + - type: conversation_part + id: '97' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + assigned_to: + author: + id: '991267562' + type: bot + name: Operator + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + total_count: 2 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: e4c692dd-cccd-46bf-834a-cda7a3a9029c + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 58e6b9ee-4a28-4597-9c20-faf34b6894dc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: cf6fb162-88c9-45ec-9f97-c3fcad93b7c1 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_conversation_request" + examples: + conversation_found: + summary: conversation found + value: + read: true + custom_attributes: + issue_type: Billing + priority: High + not_found: + summary: Not found + value: + read: true + custom_attributes: + issue_type: Billing + priority: High + "/conversations/search": + post: + summary: Search conversations + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: searchConversations + description: | + You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + + To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. + + This will accept a query object in the body which will define your filters in order to search for conversations. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiple's there can be: + - There's a limit of max 2 nested filters + - There's a limit of max 15 filters for each AND or OR group + + ### Accepted Fields + + Most keys listed as part of the The conversation model is searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + + | Field | Type | + | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + | id | String | + | created_at | Date (UNIX timestamp) | + | updated_at | Date (UNIX timestamp) | + | source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. | + | source.id | String | + | source.delivered_as | String | + | source.subject | String | + | source.body | String | + | source.author.id | String | + | source.author.type | String | + | source.author.name | String | + | source.author.email | String | + | source.url | String | + | contact_ids | String | + | teammate_ids | String | + | admin_assignee_id | String | + | team_assignee_id | String | + | channel_initiated | String | + | open | Boolean | + | read | Boolean | + | state | String | + | waiting_since | Date (UNIX timestamp) | + | snoozed_until | Date (UNIX timestamp) | + | tag_ids | String | + | priority | String | + | statistics.time_to_assignment | Integer | + | statistics.time_to_admin_reply | Integer | + | statistics.time_to_first_close | Integer | + | statistics.time_to_last_close | Integer | + | statistics.median_time_to_reply | Integer | + | statistics.first_contact_reply_at | Date (UNIX timestamp) | + | statistics.first_assignment_at | Date (UNIX timestamp) | + | statistics.first_admin_reply_at | Date (UNIX timestamp) | + | statistics.first_close_at | Date (UNIX timestamp) | + | statistics.last_assignment_at | Date (UNIX timestamp) | + | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + | statistics.last_contact_reply_at | Date (UNIX timestamp) | + | statistics.last_admin_reply_at | Date (UNIX timestamp) | + | statistics.last_close_at | Date (UNIX timestamp) | + | statistics.last_closed_by_id | String | + | statistics.count_reopens | Integer | + | statistics.count_assignments | Integer | + | statistics.count_conversation_parts | Integer | + | conversation_rating.requested_at | Date (UNIX timestamp) | + | conversation_rating.replied_at | Date (UNIX timestamp) | + | conversation_rating.score | Integer | + | conversation_rating.remark | String | + | conversation_rating.contact_id | String | + | conversation_rating.admin_d | String | + | ai_agent_participated | Boolean | + | ai_agent.resolution_state | String | + | ai_agent.last_answer_type | String | + | ai_agent.rating | Integer | + | ai_agent.rating_remark | String | + | ai_agent.source_type | String | + | ai_agent.source_title | String | + + ### Accepted Operators + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :----------------------------- | :----------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In Shortcut for `OR` queries Values most be in Array | + | NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | + | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: conversation.list + pages: + type: pages + page: 1 + per_page: 5 + total_pages: 1 + total_count: 1 + conversations: + - type: conversation + id: '378' + created_at: 1719492843 + updated_at: 1719492843 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918266' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267591' + name: Ciaran180 Lee + email: admin180@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60ea8a68186f43bafdec + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + schema: + "$ref": "#/components/schemas/conversation_list" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: created_at + operator: ">" + value: '1306054154' + pagination: + per_page: 5 + "/conversations/{id}/reply": + post: + summary: Reply to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The Intercom provisioned identifier for the conversation or the + string "last" to reply to the last part of the conversation + example: 123 or "last" + schema: + type: string + tags: + - Conversations + operationId: replyConversation + description: You can reply to a conversation with a message from an admin or + on behalf of a contact, or with a note for admins. + responses: + '200': + description: User last conversation reply + content: + application/json: + examples: + User reply: + value: + type: conversation + id: '387' + created_at: 1719492849 + updated_at: 1719492850 + waiting_since: 1719492850 + snoozed_until: + source: + type: conversation + id: '403918269' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267594' + name: Ciaran182 Lee + email: admin182@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f18a68186f43bafdf4 + external_id: '70' + first_contact_reply: + created_at: 1719492850 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '99' + part_type: open + body: "

Thanks again :)

" + created_at: 1719492850 + updated_at: 1719492850 + notified_at: 1719492850 + assigned_to: + author: + id: 667d60f18a68186f43bafdf4 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Admin note reply: + value: + type: conversation + id: '388' + created_at: 1719492852 + updated_at: 1719492853 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918270' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267596' + name: Ciaran183 Lee + email: admin183@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f38a68186f43bafdf5 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '100' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
    • +
  • Tea
    • +
  • Milk
    • +
+

An Ordered HTML List

+
    +
  1. Coffee
    2. +
  2. Tea
    3. +
  3. Milk
    4. +
+ created_at: 1719492853 + updated_at: 1719492853 + notified_at: 1719492853 + assigned_to: + author: + id: '991267596' + type: admin + name: Ciaran183 Lee + email: admin183@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + User last conversation reply: + value: + type: conversation + id: '390' + created_at: 1719492855 + updated_at: 1719492856 + waiting_since: 1719492856 + snoozed_until: + source: + type: conversation + id: '403918272' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267600' + name: Ciaran185 Lee + email: admin185@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f78a68186f43bafdf7 + external_id: '70' + first_contact_reply: + created_at: 1719492856 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '101' + part_type: open + body: "

Thanks again :)

" + created_at: 1719492856 + updated_at: 1719492856 + notified_at: 1719492856 + assigned_to: + author: + id: 667d60f78a68186f43bafdf7 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 8193a639-aba8-4b0e-9fdd-ee48807e3ee7 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7435aa28-13bd-40b1-ba99-66009e92a1ba + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 9fe5809c-cf0b-4a0f-af80-9913d3beb1eb + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/reply_conversation_request" + examples: + user_reply: + summary: User reply + value: + message_type: comment + type: user + intercom_user_id: 667d60f18a68186f43bafdf4 + body: Thanks again :) + admin_note_reply: + summary: Admin note reply + value: + message_type: note + type: admin + admin_id: 991267596 + body: "

An Unordered HTML List

  • Coffee
    • + \
  • Tea
  • Milk

An Ordered HTML List

+ \
  1. Coffee
  2. Tea
  3. Milk
+ \ " + user_last_conversation_reply: + summary: User last conversation reply + value: + message_type: comment + type: user + intercom_user_id: 667d60f78a68186f43bafdf7 + body: Thanks again :) + not_found: + summary: Not found + value: + message_type: comment + type: user + intercom_user_id: 667d60f98a68186f43bafdf8 + body: Thanks again :) + "/conversations/{id}/parts": + post: + summary: Manage a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: manageConversation + description: | + For managing conversations you can: + - Close a conversation + - Snooze a conversation to reopen on a future date + - Open a conversation which is `snoozed` or `closed` + - Assign a conversation to an admin and/or team. + responses: + '200': + description: Assign a conversation + content: + application/json: + examples: + Close a conversation: + value: + type: conversation + id: '394' + created_at: 1719492862 + updated_at: 1719492862 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918276' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267608' + name: Ciaran189 Lee + email: admin189@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60fd8a68186f43bafdfb + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '102' + part_type: close + body: "

Goodbye :)

" + created_at: 1719492862 + updated_at: 1719492862 + notified_at: 1719492862 + assigned_to: + author: + id: '991267608' + type: admin + name: Ciaran189 Lee + email: admin189@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Snooze a conversation: + value: + type: conversation + id: '395' + created_at: 1719492864 + updated_at: 1719492864 + waiting_since: + snoozed_until: 1719496464 + source: + type: conversation + id: '403918277' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267610' + name: Ciaran190 Lee + email: admin190@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60ff8a68186f43bafdfc + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: true + state: snoozed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '103' + part_type: snoozed + body: + created_at: 1719492864 + updated_at: 1719492864 + notified_at: 1719492864 + assigned_to: + author: + id: '991267610' + type: admin + name: Ciaran190 Lee + email: admin190@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Open a conversation: + value: + type: conversation + id: '400' + created_at: 1719492863 + updated_at: 1719492873 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918278' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267612' + name: Ciaran191 Lee + email: admin191@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61038a68186f43bafe01 + external_id: '74' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: '' + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '105' + part_type: open + body: + created_at: 1719492873 + updated_at: 1719492873 + notified_at: 1719492873 + assigned_to: + author: + id: '991267612' + type: admin + name: Ciaran191 Lee + email: admin191@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Assign a conversation: + value: + type: conversation + id: '405' + created_at: 1719492874 + updated_at: 1719492875 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918281' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267615' + name: Ciaran193 Lee + email: admin193@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d610a8a68186f43bafe05 + external_id: '70' + first_contact_reply: + admin_assignee_id: 991267615 + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '106' + part_type: assign_and_reopen + body: + created_at: 1719492875 + updated_at: 1719492875 + notified_at: 1719492875 + assigned_to: + type: admin + id: '991267615' + author: + id: '991267615' + type: admin + name: Ciaran193 Lee + email: admin193@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 1bfc14e1-07ef-4999-9448-f029b112cf1b + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ae0581d2-199e-437c-bf51-1eb9fe2e12fc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: a7e069bb-f013-45bc-8e0a-f58c3de4e034 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/close_conversation_request" + - "$ref": "#/components/schemas/snooze_conversation_request" + - "$ref": "#/components/schemas/open_conversation_request" + - "$ref": "#/components/schemas/assign_conversation_request" + examples: + close_a_conversation: + summary: Close a conversation + value: + message_type: close + type: admin + admin_id: 991267608 + body: Goodbye :) + snooze_a_conversation: + summary: Snooze a conversation + value: + message_type: snoozed + admin_id: 991267610 + snoozed_until: 1719496464 + open_a_conversation: + summary: Open a conversation + value: + message_type: open + admin_id: 991267612 + assign_a_conversation: + summary: Assign a conversation + value: + message_type: assignment + type: admin + admin_id: 991267615 + assignee_id: 991267615 + not_found: + summary: Not found + value: + message_type: close + type: admin + admin_id: 991267617 + body: Goodbye :) + "/conversations/{id}/run_assignment_rules": + post: + summary: Run Assignment Rules on a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: autoAssignConversation + description: | + You can let a conversation be automatically assigned following assignment rules. + {% admonition type="attention" name="When using workflows" %} + It is not possible to use this endpoint with Workflows. + {% /admonition %} + responses: + '200': + description: Assign a conversation using assignment rules + content: + application/json: + examples: + Assign a conversation using assignment rules: + value: + type: conversation + id: '409' + created_at: 1719492880 + updated_at: 1719492881 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918285' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267623' + name: Ciaran197 Lee + email: admin197@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61108a68186f43bafe09 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '107' + part_type: default_assignment + body: + created_at: 1719492881 + updated_at: 1719492881 + notified_at: 1719492881 + assigned_to: + type: nobody_admin + id: + author: + id: '991267624' + type: bot + name: Operator + email: operator+this_is_an_id364_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 9d88a5a7-6df9-42ff-b324-2387db7be984 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 8aeac960-c7fb-41f7-8cc9-cd3d62f6ff92 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: '037980c4-84cb-4d3a-ad64-66e4e563a275' + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + "/conversations/{id}/customers": + post: + summary: Attach a contact to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: attachContactToConversation + description: |+ + You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + + {% admonition type="attention" name="Contacts without an email" %} + If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. + {% /admonition %} + + responses: + '200': + description: Attach a contact to a conversation + content: + application/json: + examples: + Attach a contact to a conversation: + value: + customers: + - type: user + id: 667d61168a68186f43bafe0d + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 1fd64942-5bf0-4a51-a6cb-db4a778bb1f4 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4f00c4c6-a8f7-436e-bf95-d1adfa315906 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 3d1c3371-6ba4-4d5a-9368-ac983292136d + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/attach_contact_to_conversation_request" + examples: + attach_a_contact_to_a_conversation: + summary: Attach a contact to a conversation + value: + admin_id: 991267631 + customer: + intercom_user_id: 667d61168a68186f43bafe0d + not_found: + summary: Not found + value: + admin_id: 991267633 + customer: + intercom_user_id: 667d61188a68186f43bafe0e + "/conversations/{conversation_id}/customers/{contact_id}": + delete: + summary: Detach a contact from a group conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + - name: contact_id + in: path + required: true + description: The identifier for the contact as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: detachContactFromConversation + description: |+ + You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + + {% admonition type="attention" name="Contacts without an email" %} + If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. + {% /admonition %} + + responses: + '200': + description: Detach a contact from a group conversation + content: + application/json: + examples: + Detach a contact from a group conversation: + value: + customers: + - type: user + id: 667d61228a68186f43bafe19 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Contact not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: 579f0f7a-d773-41d6-9d36-8cc0b3fbcc41 + errors: + - code: not_found + message: Resource Not Found + Contact not found: + value: + type: error.list + request_id: 44531412-2973-4b92-b14d-80abac5c1b4d + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '422': + description: Last customer + content: + application/json: + examples: + Last customer: + value: + type: error.list + request_id: 35a0444f-8a1e-40e9-a5fc-dd1ae2df8bc6 + errors: + - code: parameter_invalid + message: Removing the last customer is not allowed + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d35f1b37-765c-4afe-8738-81c0560710a6 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: d30f18d4-2e0a-4528-a66b-4590b733713c + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/detach_contact_from_conversation_request" + examples: + detach_a_contact_from_a_group_conversation: + summary: Detach a contact from a group conversation + value: + admin_id: 991267639 + customer: + intercom_user_id: 667d611c8a68186f43bafe11 + conversation_not_found: + summary: Conversation not found + value: + admin_id: 991267642 + customer: + intercom_user_id: 667d61248a68186f43bafe1a + contact_not_found: + summary: Contact not found + value: + admin_id: 991267645 + customer: + intercom_user_id: 667d612b8a68186f43bafe22 + last_customer: + summary: Last customer + value: + admin_id: 991267648 + customer: + intercom_user_id: 667d61338a68186f43bafe2a + "/conversations/redact": + post: + summary: Redact a conversation part + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: redactConversation + description: |+ + You can redact a conversation part or the source message of a conversation (as seen in the source object). + + {% admonition type="info" name="Redacting parts and messages" %} + If you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met. + {% /admonition %} + + responses: + '200': + description: Redact a conversation part + content: + application/json: + examples: + Redact a conversation part: + value: + type: conversation + id: '471' + created_at: 1719492938 + updated_at: 1719492940 + waiting_since: 1719492939 + snoozed_until: + source: + type: conversation + id: '403918311' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267657' + name: Ciaran217 Lee + email: admin217@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d614a8a68186f43bafe42 + external_id: '70' + first_contact_reply: + created_at: 1719492939 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '115' + part_type: open + body: "

This message was deleted

" + created_at: 1719492939 + updated_at: 1719492940 + notified_at: 1719492939 + assigned_to: + author: + id: 667d614a8a68186f43bafe42 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: true + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 0c016386-49f4-431f-92dc-7e739cbf98e1 + errors: + - code: conversation_part_or_message_not_found + message: Conversation part or message not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 1b830d07-a249-4ff8-a7bf-41bf83fd53b2 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/redact_conversation_request" + examples: + redact_a_conversation_part: + summary: Redact a conversation part + value: + type: conversation_part + conversation_id: 471 + conversation_part_id: 115 + not_found: + summary: Not found + value: + type: conversation_part + conversation_id: really_123_doesnt_exist + conversation_part_id: really_123_doesnt_exist + "/conversations/{id}/convert": + post: + summary: Convert a conversation to a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + tags: + - Conversations + description: You can convert a conversation to a ticket. + operationId: convertConversationToTicket + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: ticket + id: '474' + ticket_id: '37' + ticket_attributes: {} + ticket_state: submitted + ticket_type: + type: ticket_type + id: '79' + name: my-ticket-type-1 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id404_that_should_be_at_least_ + archived: false + created_at: 1719492947 + updated_at: 1719492947 + is_internal: false + ticket_type_attributes: + type: list + data: [] + category: Customer + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61518a68186f43bafe45 + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719492945 + updated_at: 1719492947 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '117' + part_type: comment + body: "

Comment for message

" + created_at: 1719492945 + updated_at: 1719492945 + author: + id: 667d61518a68186f43bafe45 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + redacted: false + - type: ticket_part + id: '118' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719492947 + updated_at: 1719492947 + author: + id: '991267667' + type: bot + name: Operator + email: operator+this_is_an_id404_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 2 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Customer + is_shared: true + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket" + '400': + description: Bad request + content: + application/json: + examples: + Bad request: + value: + type: error.list + request_id: 74656c1a-0a17-4c80-a7b9-66fa45c6d71b + errors: + - code: parameter_invalid + message: Ticket type is not a customer ticket type + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/convert_conversation_to_ticket_request" + examples: + successful: + summary: successful + value: + ticket_type_id: '79' + bad_request: + summary: Bad request + value: + ticket_type_id: '80' + "/data_attributes": + get: + summary: List all data attributes + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: model + in: query + required: false + description: Specify the data attribute model to return. + schema: + type: string + enum: + - contact + - company + - conversation + example: company + - name: include_archived + in: query + required: false + description: Include archived attributes in the list. By default we return + only non archived data attributes. + example: false + schema: + type: boolean + tags: + - Data Attributes + operationId: lisDataAttributes + description: You can fetch a list of all data attributes belonging to a workspace + for contacts, companies or conversations. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: list + data: + - type: data_attribute + name: name + full_name: name + label: Company name + description: The name of a company + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: company_id + full_name: company_id + label: Company ID + description: A number identifying a company + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: last_request_at + full_name: last_request_at + label: Company last seen + description: The last day anyone from a company visited your + site or app + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: remote_created_at + full_name: remote_created_at + label: Company created at + description: The day a company was added to Intercom + data_type: date + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: user_count + full_name: user_count + label: People + description: The number of people in a company + data_type: integer + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: session_count + full_name: session_count + label: Company web sessions + description: All visits from anyone in a company to your product's + site or app + data_type: integer + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: name + full_name: plan.name + label: Plan + description: A specific plan or level within your product that + companies have signed up to + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: monthly_spend + full_name: monthly_spend + label: Monthly Spend + description: The monthly revenue you receive from a company + data_type: float + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: size + full_name: size + label: Company size + description: The number of people employed in this company, + expressed as a single number + data_type: integer + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: industry + full_name: industry + label: Company industry + description: The category or domain this company belongs to + e.g. 'ecommerce' or 'SaaS' + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: website + full_name: website + label: Company website + description: The web address for the company's primary marketing + site + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - id: 34 + type: data_attribute + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: One ring to rule them all, one ring to find them, + One ring to bring them all and in the darkness bind them. + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: true + archived: false + admin_id: '991267684' + created_at: 1719492954 + updated_at: 1719492954 + model: company + - type: data_attribute + name: id + full_name: id + label: ID + description: The Intercom defined id representing the company + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: created_at + full_name: created_at + label: Created at + description: The time the company was added to Intercom + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: updated_at + full_name: updated_at + label: Updated at + description: The last time the company was updated + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: id + full_name: plan.id + label: Plan ID + description: The Intercom defined id representing the plan + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: app_id + full_name: app_id + label: App ID + description: The Intercom defined id representing the app + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + schema: + "$ref": "#/components/schemas/data_attribute_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6e76e914-a34d-4125-8310-62fdfc4e651e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a data attribute + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Attributes + operationId: createDataAttribute + description: You can create a data attributes for a `contact` or a `company`. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 37 + type: data_attribute + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + data_type: string + api_writable: true + ui_writable: false + messenger_writable: false + custom: true + archived: false + admin_id: '991267686' + created_at: 1719492955 + updated_at: 1719492955 + model: company + schema: + "$ref": "#/components/schemas/data_attribute" + '400': + description: Too few options for list + content: + application/json: + examples: + Same name already exists: + value: + type: error.list + request_id: bcd93885-3f01-4b92-9918-c96a3f4492e8 + errors: + - code: parameter_invalid + message: You already have 'The One Ring' in your company data. + To save this as new people data, use a different name. + Invalid name: + value: + type: error.list + request_id: 7420c5e3-22c3-46be-8a23-72fef8f8ec0e + errors: + - code: parameter_invalid + message: Your name for this attribute must only contain alphanumeric + characters, currency symbols, and hyphens + Attribute already exists: + value: + type: error.list + request_id: c844551a-05d3-4f8c-931a-32e96bf3a508 + errors: + - code: parameter_invalid + message: You already have 'The One Ring' in your company data. + To save this as new company data, use a different name. + Invalid Data Type: + value: + type: error.list + request_id: b8c58b81-8445-473d-8fe3-7880c04f9547 + errors: + - code: parameter_invalid + message: Data Type isn't an option + Too few options for list: + value: + type: error.list + request_id: 119e3822-3a45-48cf-b5ab-037f27a948c8 + errors: + - code: parameter_invalid + message: The Data Attribute model field must be either contact + or company + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b74d8980-6e99-44db-a3d8-2a65a63fe590 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_attribute_request" + examples: + successful: + summary: Successful + value: + name: Mithril Shirt + model: company + data_type: string + same_name_already_exists: + summary: Same name already exists + value: + name: The One Ring + model: contact + data_type: integer + invalid_name: + summary: Invalid name + value: + name: "!nv@l!d n@me" + model: company + data_type: string + attribute_already_exists: + summary: Attribute already exists + value: + name: The One Ring + model: company + data_type: string + invalid_data_type: + summary: Invalid Data Type + value: + name: The Second Ring + model: company + data_type: mithril + too_few_options_for_list: + summary: Too few options for list + value: + description: Just a plain old ring + options: + - value: 1-10 + archived: false + "/data_attributes/{id}": + put: + summary: Update a data attribute + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The data attribute id + example: 1 + schema: + type: integer + tags: + - Data Attributes + operationId: updateDataAttribute + description: "\nYou can update a data attribute.\n\n> \U0001F6A7 Updating the + data type is not possible\n>\n> It is currently a dangerous action to execute + changing a data attribute's type via the API. You will need to update the + type via the UI instead.\n" + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 44 + type: data_attribute + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + ui_writable: false + messenger_writable: true + custom: true + archived: false + admin_id: '991267693' + created_at: 1719492958 + updated_at: 1719492959 + model: company + schema: + "$ref": "#/components/schemas/data_attribute" + '400': + description: Too few options in list + content: + application/json: + examples: + Too few options in list: + value: + type: error.list + request_id: 6615f20c-01df-443c-9ea1-c954ba6b09d6 + errors: + - code: parameter_invalid + message: Options isn't an array + schema: + "$ref": "#/components/schemas/error" + '404': + description: Attribute Not Found + content: + application/json: + examples: + Attribute Not Found: + value: + type: error.list + request_id: 2680a225-4f79-4098-8438-8db993c639fe + errors: + - code: field_not_found + message: We couldn't find that data attribute to update + schema: + "$ref": "#/components/schemas/error" + '422': + description: Has Dependant Object + content: + application/json: + examples: + Has Dependant Object: + value: + type: error.list + request_id: fbc508f1-9cbf-4134-90ea-baa1065760d2 + errors: + - code: data_invalid + message: The Data Attribute you are trying to archive has a + dependant object + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0cfc97c0-32be-4e68-aef2-f5744e4e85f7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_data_attribute_request" + examples: + successful: + summary: Successful + value: + description: Just a plain old ring + options: + - value: 1-10 + - value: 11-20 + archived: false + too_few_options_in_list: + summary: Too few options in list + value: + description: Too few options + options: + value: 1-10 + archived: false + attribute_not_found: + summary: Attribute Not Found + value: + description: Just a plain old ring + options: + - value: 1-10 + - value: 11-20 + archived: false + has_dependant_object: + summary: Has Dependant Object + value: + description: Trying to archieve + archived: true + "/events": + post: + summary: Submit a data event + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Events + operationId: createDataEvent + description: |2+ + + You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + + When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + + With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + + **NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + + | Type | Description | Example | + | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + | String | The value is a JSON String | `"source":"desktop"` | + | Number | The value is a JSON Number | `"load": 3.67` | + | Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | + | Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | + | Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | + | Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + + **Lead Events** + + When submitting events for Leads, you will need to specify the Lead's `id`. + + **Metadata behaviour** + + - We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. + - It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. + - There might be up to 24 hrs delay when you send a new metadata for an existing event. + + **Event de-duplication** + + The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + + Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + + ### HTTP API Responses + + - Successful responses to submitted events return `202 Accepted` with an empty body. + - Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. + - Events sent about users that cannot be found will return a `404 Not Found`. + - Event lists containing duplicate events will have those duplicates ignored. + - Server errors will return a `500` response code and may contain an error message in the body. + + responses: + '202': + description: successful + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c6b3dcbd-33be-4a80-abb4-c5b3315250d0 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_event_request" + get: + summary: List all data events + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - in: query + name: filter + required: true + style: form + explode: true + schema: + type: object + oneOf: + - title: user_id query parameter + properties: + user_id: + type: string + required: + - user_id + additionalProperties: false + - title: intercom_user_id query parameter + properties: + intercom_user_id: + type: string + required: + - intercom_user_id + additionalProperties: false + - title: email query parameter + properties: + email: + type: string + required: + - email + additionalProperties: false + - name: type + in: query + required: true + description: The value must be user + schema: + type: string + - name: summary + in: query + required: false + description: summary flag + schema: + type: boolean + tags: + - Data Events + operationId: lisDataEvents + description: "\n> \U0001F6A7\n>\n> Please note that you can only 'list' events + that are less than 90 days old. Event counts and summaries will still include + your events older than 90 days but you cannot 'list' these events individually + if they are older than 90 days\n\nThe events belonging to a customer can be + listed by sending a GET request to `https://api.intercom.io/events` with a + user or lead identifier along with a `type` parameter. The identifier parameter + can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter + value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- + `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` + (this call can be used to list leads)\n\nThe `email` parameter value should + be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou + can optionally define the result page size as well with the `per_page` parameter.\n" + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: event.summary + events: [] + pages: + next: http://api.intercom.test/events?next page + email: user26@email.com + intercom_user_id: 667d61648a68186f43bafe4b + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + schema: + "$ref": "#/components/schemas/data_event_summary" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: bfdcc6de-2dcb-4725-acc7-232c10838586 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/events/summaries": + post: + summary: Create event summaries + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Events + operationId: dataEventSummaries + description: "Create event summaries for a user. Event summaries are used to + track the number of times an event has occurred, the first time it occurred + and the last time it occurred.\n\n" + responses: + '200': + description: successful + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 110801d1-2f7b-436f-8f03-2245545a1432 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_event_summaries_request" + "/export/content/data": + post: + summary: Create content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Export + operationId: createDataExport + description: "To create your export job, you need to send a `POST` request to + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 + Limit of one active job\n>\n> You can only have one active job per workspace. + You will receive a HTTP status code of 429 with the message Exceeded rate + limit of 1 pending message data export jobs if you attempt to create a second + concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that + the timeframe only includes messages sent during the time period and not messages + that were only updated during this period. For example, if a message was updated + yesterday but sent two days ago, you would need to set the created_at_after + date before the message was sent to include that in your retrieval job.\n\n>\U0001F4D8 + Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 + will get all data for those days including those specified - e.g. 2018-06-01 + 00:00:00 until 2018-06-30 23:59:99.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: bxe9awlish03jkq8 + status: pending + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_exports_request" + examples: + successful: + summary: successful + value: + created_at_after: 1719474967 + created_at_before: 1719492967 + "/export/content/data/{job_identifier}": + get: + summary: Show content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: getDataExport + description: "You can view the status of your job by sending a `GET` request + to the URL\n`https://api.intercom.io/export/content/data/{job_identifier}` + - the `{job_identifier}` is the value returned in the response when you first + created the export job. More on it can be seen in the Export Job Model.\n\n> + \U0001F6A7 Jobs expire after two days\n> All jobs that have completed processing + (and are thus available to download from the provided URL) will have an expiry + limit of two days from when the export ob completed. After this, the data + will no longer be available.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: b1ppo8h93fj386fk + status: pending + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + "/export/cancel/{job_identifier}": + post: + summary: Cancel content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: cancelDataExport + description: You can cancel your job + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: pwrbmmimhakvlfsh + status: canceled + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + "/download/content/data/{job_identifier}": + get: + summary: Download content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: downloadDataExport + description: "When a job has a status of complete, and thus a filled download_url, + you can download your data by hitting that provided URL, formatted like so: + https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message + data will be streamed continuously back down to you in a gzipped CSV format.\n\n> + \U0001F4D8 Octet header required\n>\n> You will have to specify the header + Accept: `application/octet-stream` when hitting this endpoint.\n" + responses: + '200': + description: successful + "/messages": + post: + summary: Create a message + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Messages + operationId: createMessage + description: "You can create a message that has been initiated by an admin. + The conversation can be either an in-app message or an email.\n\n> \U0001F6A7 + Sending for visitors\n>\n> There can be a short delay between when a contact + is created and when a contact becomes available to be messaged through the + API. A 404 Not Found error will be returned in this case.\n\nThis will return + the Message model that has been created.\n\n> \U0001F6A7 Retrieving Associated + Conversations\n>\n> As this is a message, there will be no conversation present + until the contact responds. Once they do, you will have to search for a contact's + conversations with the id of the message.\n" + responses: + '200': + description: admin message created + content: + application/json: + examples: + user message created: + value: + type: user_message + id: '403918316' + created_at: 1719492969 + body: heyy + message_type: inapp + conversation_id: '476' + lead message created: + value: + type: user_message + id: '403918317' + created_at: 1719492971 + body: heyy + message_type: inapp + conversation_id: '477' + admin message created: + value: + type: admin_message + id: '15' + created_at: 1719492972 + subject: heyy + body: heyy + message_type: inapp + owner: + type: admin + id: '991267716' + name: Ciaran269 Lee + email: admin269@email.com + away_mode_enabled: false + away_mode_reassign: false + schema: + "$ref": "#/components/schemas/message" + '400': + description: No body supplied for email message + content: + application/json: + examples: + No body supplied for message: + value: + type: error.list + request_id: 4a52a34f-c7e2-4e70-adf2-ea7f41beb2a1 + errors: + - code: parameter_invalid + message: Body is required + No body supplied for email message: + value: + type: error.list + request_id: 7d54191b-c0fc-4860-a01c-9da6b4e45b7f + errors: + - code: parameter_invalid + message: Body is required + schema: + "$ref": "#/components/schemas/error" + '422': + description: No subject supplied for email message + content: + application/json: + examples: + No subject supplied for email message: + value: + type: error.list + request_id: f54ba906-3255-4fc6-a660-0dab0043ff2b + errors: + - code: parameter_not_found + message: No subject supplied for email message + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ee3ea56e-d0ce-47db-871a-57740e165e5c + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: fab7034a-78bd-4413-a652-8f38783e7bf1 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_message_request" + examples: + user_message_created: + summary: user message created + value: + from: + type: user + id: 667d61698a68186f43bafe50 + body: heyy + referer: https://twitter.com/bob + lead_message_created: + summary: lead message created + value: + from: + type: lead + id: 667d616a8a68186f43bafe51 + body: heyy + referer: https://twitter.com/bob + admin_message_created: + summary: admin message created + value: + from: + type: admin + id: '991267716' + to: + type: user + id: 667d616c8a68186f43bafe52 + message_type: conversation + body: heyy + no_body_supplied_for_message: + summary: No body supplied for message + value: + from: + type: admin + id: '991267718' + to: + type: user + id: 667d616d8a68186f43bafe53 + message_type: inapp + body: + subject: heyy + no_subject_supplied_for_email_message: + summary: No subject supplied for email message + value: + from: + type: admin + id: '991267719' + to: + type: user + user_id: '70' + message_type: email + body: hey there + no_body_supplied_for_email_message: + summary: No body supplied for email message + value: + from: + type: admin + id: '991267720' + to: + type: user + id: 667d616e8a68186f43bafe55 + message_type: email + body: + subject: heyy + "/news/news_items": + get: + summary: List all news items + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: listNewsItems + description: You can fetch a list of all news items + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 10 + total_pages: 1 + type: pages + data: + - id: '29' + type: news-item + workspace_id: this_is_an_id494_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991267725 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1719492976 + updated_at: 1719492976 + newsfeed_assignments: [] + - id: '30' + type: news-item + workspace_id: this_is_an_id494_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991267727 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1719492976 + updated_at: 1719492976 + newsfeed_assignments: [] + total_count: 2 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7b27151d-7bb0-402e-87fe-5780690d9f32 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: createNewsItem + description: You can create a news item + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '33' + type: news-item + workspace_id: this_is_an_id498_that_should_be_at_least_ + title: Halloween is here! + body: "

New costumes in store for this spooky season

" + sender_id: 991267734 + state: live + labels: + - New + - Product + - Update + cover_image_url: + reactions: + - "\U0001F606" + - "\U0001F605" + deliver_silently: true + created_at: 1719492978 + updated_at: 1719492978 + newsfeed_assignments: + - newsfeed_id: 53 + published_at: 1664638214 + schema: + "$ref": "#/components/schemas/news_item" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c36202f1-6bf3-4ea6-9442-192123f506b0 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/news_item_request" + examples: + successful: + summary: successful + value: + title: Halloween is here! + body: "

New costumes in store for this spooky season

" + labels: + - Product + - Update + - New + sender_id: 991267734 + deliver_silently: true + reactions: + - "\U0001F606" + - "\U0001F605" + state: live + newsfeed_assignments: + - newsfeed_id: 53 + published_at: 1664638214 + "/news/news_items/{id}": + get: + summary: Retrieve a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: retrieveNewsItem + description: You can fetch the details of a single news item. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '34' + type: news-item + workspace_id: this_is_an_id502_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991267737 + state: live + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1719492979 + updated_at: 1719492979 + newsfeed_assignments: + - newsfeed_id: 55 + published_at: 1719492980 + schema: + "$ref": "#/components/schemas/news_item" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: 0f4b439e-9b57-4019-886e-15cc08582914 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: cc6af01d-81e3-4a74-8a62-807a3239e1ad + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: updateNewsItem + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '37' + type: news-item + workspace_id: this_is_an_id508_that_should_be_at_least_ + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + sender_id: 991267745 + state: live + labels: [] + cover_image_url: + reactions: + - "\U0001F61D" + - "\U0001F602" + deliver_silently: false + created_at: 1719492982 + updated_at: 1719492982 + newsfeed_assignments: [] + schema: + "$ref": "#/components/schemas/news_item" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: fe6e217d-70bc-4090-b33a-b32ec0e6a391 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f780a591-4aa2-4382-80c4-e0f2d655bf2e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/news_item_request" + examples: + successful: + summary: successful + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + sender_id: 991267745 + reactions: + - "\U0001F61D" + - "\U0001F602" + news_item_not_found: + summary: News Item Not Found + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + sender_id: 991267748 + reactions: + - "\U0001F61D" + - "\U0001F602" + delete: + summary: Delete a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: deleteNewsItem + description: You can delete a single news item. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '40' + object: news-item + deleted: true + schema: + "$ref": "#/components/schemas/deleted_object" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: a191b999-6f71-4676-a8db-1a79ccc4f114 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 521cb8a5-4d47-43dd-94cb-ef54f6f8ce0a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds/{id}/items": + get: + summary: List all live newsfeed items + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news feed item which is given by + Intercom. + example: '123' + schema: + type: string + tags: + - News + operationId: listLiveNewsfeedItems + description: You can fetch a list of all news items that are live on a given + newsfeed + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 20 + total_pages: 0 + type: pages + data: [] + total_count: 0 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: de07bbcf-64ff-4fc8-a7e5-fcbe772b85a5 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds": + get: + summary: List all newsfeeds + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: listNewsfeeds + description: You can fetch a list of all newsfeeds + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 10 + total_pages: 1 + type: pages + data: + - id: '68' + type: newsfeed + name: Visitor Feed + created_at: 1719492987 + updated_at: 1719492987 + - id: '69' + type: newsfeed + name: Visitor Feed + created_at: 1719492987 + updated_at: 1719492987 + total_count: 2 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d00f8d67-1e7c-464b-b0b7-b2409d706076 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds/{id}": + get: + summary: Retrieve a newsfeed + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news feed item which is given by + Intercom. + example: '123' + schema: + type: string + tags: + - News + operationId: retrieveNewsfeed + description: You can fetch the details of a single newsfeed + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '72' + type: newsfeed + name: Visitor Feed + created_at: 1719492988 + updated_at: 1719492988 + schema: + "$ref": "#/components/schemas/newsfeed" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 185ce494-34e2-4cda-85cb-c51ad7281292 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/notes/{id}": + get: + summary: Retrieve a note + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given note + example: 1 + schema: + type: integer + tags: + - Notes + operationId: retrieveNote + description: You can fetch the details of a single note. + responses: + '200': + description: Note found + content: + application/json: + examples: + Note found: + value: + type: note + id: '37' + created_at: 1718801789 + contact: + type: contact + id: 667d617d8a68186f43bafe58 + author: + type: admin + id: '991267764' + name: Ciaran316 Lee + email: admin316@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + schema: + "$ref": "#/components/schemas/note" + '404': + description: Note not found + content: + application/json: + examples: + Note not found: + value: + type: error.list + request_id: 7e37eb4e-9f1e-47fa-a393-8d9b2c20983a + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b29ebc05-ba35-4db8-aac6-d74617769643 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/segments": + get: + summary: List all segments + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: include_count + in: query + required: false + description: It includes the count of contacts that belong to each segment. + example: true + schema: + type: boolean + tags: + - Segments + operationId: listSegments + description: You can fetch a list of all segments. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: segment.list + segments: + - type: segment + id: 667d617f8a68186f43bafe5b + name: John segment + created_at: 1719492991 + updated_at: 1719492991 + person_type: user + - type: segment + id: 667d617f8a68186f43bafe5c + name: Jane segment + created_at: 1719492991 + updated_at: 1719492991 + person_type: user + schema: + "$ref": "#/components/schemas/segment_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d70c184d-852a-4f67-8298-3cf9a327adb3 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/segments/{id}": + get: + summary: Retrieve a segment + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identified of a given segment. + example: '123' + schema: + type: string + tags: + - Segments + operationId: retrieveSegment + description: You can fetch the details of a single segment. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: segment + id: 667d61808a68186f43bafe5f + name: John segment + created_at: 1719492992 + updated_at: 1719492992 + person_type: user + schema: + "$ref": "#/components/schemas/segment" + '404': + description: Segment not found + content: + application/json: + examples: + Segment not found: + value: + type: error.list + request_id: fe79fa5e-c8eb-40a6-be76-d618833c2840 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a9c190ff-16eb-43f9-94fc-7c22da2766af + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/subscription_types": + get: + summary: List subscription types + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Subscription Types + operationId: listSubscriptionTypes + description: You can list all subscription types. A list of subscription type + objects will be returned. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: subscription + id: '137' + state: live + consent_type: opt_out + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - email + schema: + "$ref": "#/components/schemas/subscription_type_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 5fb6b003-d6a6-4641-b71b-c5c468c87448 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/phone_call_redirects": + post: + summary: Create a phone Switch + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Switch + operationId: createPhoneSwitch + description: | + You can use the API to deflect phone calls to the Intercom Messenger. + Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + + If custom attributes are specified, they will be added to the user or lead's custom data attributes. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + url: http://via.intercom.io/msgr/6eb60123-dadb-4881-80fd-4fc2cf272b12 + type: phone_call_redirect + schema: + "$ref": "#/components/schemas/phone_switch" + '400': + description: bad request - invalid number + content: + application/json: + examples: + bad request - exception sending sms: + value: + error_key: sms_failed + message: SMS was not sent due to an unknown error + bad request - invalid number: + value: + error_key: invalid_phone_number + message: Invalid phone number + '422': + description: unprocessable entity + content: + application/json: + examples: + unprocessable entity: + value: + error_key: some_error + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 5da7a3e7-dcb0-4378-8575-0a0e9bae3862 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_phone_switch_request" + examples: + successful: + summary: successful + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + bad_request_-_exception_sending_sms: + summary: bad request - exception sending sms + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + bad_request_-_invalid_number: + summary: bad request - invalid number + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + unprocessable_entity: + summary: unprocessable entity + value: + phone: "+40241100100" + custom_attributes: + issue_type: Billing + priority: High + "/tags": + get: + summary: List all tags + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tags + operationId: listTags + description: "You can fetch a list of all tags for a given workspace.\n\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: tag + id: '115' + name: Manual tag 1 + schema: + "$ref": "#/components/schemas/tag_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c83a3efe-433a-4555-a5e2-e393588be29f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create or update a tag, Tag or untag companies, Tag contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tags + operationId: createTag + description: | + You can use this endpoint to perform the following operations: + + **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below. + + **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below. + + **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically. + + **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below. + + **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below. + + Each operation will return a tag object. + responses: + '200': + description: Action successful + content: + application/json: + examples: + Action successful: + value: + type: tag + id: '118' + name: test + schema: + "$ref": "#/components/schemas/tag" + '400': + description: Invalid parameters + content: + application/json: + examples: + Invalid parameters: + value: + type: error.list + request_id: a7afe3c5-be52-4b69-9268-50ef1d917a1b + errors: + - code: parameter_invalid + message: invalid tag parameters + schema: + "$ref": "#/components/schemas/error" + '404': + description: User not found + content: + application/json: + examples: + Company not found: + value: + type: error.list + request_id: f0f84d9b-3c51-4904-9c21-34faba76ebf5 + errors: + - code: company_not_found + message: Company Not Found + User not found: + value: + type: error.list + request_id: 786848c6-5b9f-4e9b-aa78-2bdec45a09f5 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3609e8b1-a6aa-4c57-a994-3d95743f20a2 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/create_or_update_tag_request" + - "$ref": "#/components/schemas/tag_company_request" + - "$ref": "#/components/schemas/untag_company_request" + - "$ref": "#/components/schemas/tag_multiple_users_request" + examples: + action_successful: + summary: Action successful + value: + name: test + invalid_parameters: + summary: Invalid parameters + value: + test: invalid + company_not_found: + summary: Company not found + value: + name: test + companies: + - company_id: '123' + user_not_found: + summary: User not found + value: + name: test + users: + - id: '123' + "/tags/{id}": + get: + summary: Find a specific tag + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string + tags: + - Tags + operationId: findTag + description: | + You can fetch the details of tags that are on the workspace by their id. + This will return a tag object. + responses: + '200': + description: Tag found + content: + application/json: + examples: + Tag found: + value: + type: tag + id: '126' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Tag not found: + value: + type: error.list + request_id: 20b89fb6-f224-4f81-98ca-4cb4b36df959 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 76a1d79d-3f0d-49bb-8d15-38d1ae6df738 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete tag + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string + tags: + - Tags + operationId: deleteTag + description: You can delete the details of tags that are on the workspace by + passing in the id. + responses: + '200': + description: Successful + '404': + description: Resource not found + content: + application/json: + examples: + Resource not found: + value: + type: error.list + request_id: 111586bb-ad78-43b9-b0a0-bf864d9a3744 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '400': + description: Tag has dependent objects + content: + application/json: + examples: + Tag has dependent objects: + value: + type: error.list + request_id: 41086388-9b3b-4e07-9633-502b9b10c926 + errors: + - code: tag_has_dependent_objects + message: 'Unable to delete Tag with dependent objects. Segments: + Seg 1.' + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3dcedf54-ed30-4337-8992-94e36900e695 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/teams": + get: + summary: List all teams + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Teams + operationId: listTeams + description: This will return a list of team objects for the App. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: team.list + teams: [] + schema: + "$ref": "#/components/schemas/team_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 006b2c8f-9a29-463e-be69-ad213576aee6 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/teams/{id}": + get: + summary: Retrieve a team + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given team. + example: '123' + schema: + type: string + tags: + - Teams + operationId: retrieveTeam + description: You can fetch the details of a single team, containing an array + of admins that belong to this team. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: team + id: '991267802' + name: team 1 + admin_ids: [] + schema: + "$ref": "#/components/schemas/team" + '404': + description: Team not found + content: + application/json: + examples: + Team not found: + value: + type: error.list + request_id: 4745dfce-7275-4864-abfd-44e0d84bf52a + errors: + - code: team_not_found + message: Team not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 110ad8e4-99ed-461a-bd93-92a5cdbaa6b2 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/ticket_types/{ticket_type_id}/attributes": + post: + summary: Create a new attribute for a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_type_id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Type Attributes + description: You can create a new attribute for a ticket type. + operationId: createTicketTypeAttribute + responses: + '200': + description: Ticket Type Attribute created + content: + application/json: + examples: + Ticket Type Attribute created: + value: + type: ticket_type_attribute + id: '210' + workspace_id: this_is_an_id600_that_should_be_at_least_ + name: Attribute Title + description: Attribute Description + data_type: string + input_options: + multiline: false + order: 2 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: false + ticket_type_id: 81 + archived: false + created_at: 1719493013 + updated_at: 1719493013 + schema: + "$ref": "#/components/schemas/ticket_type_attribute" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3bc672fa-e051-4ede-b6e9-79f518231ba9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_type_attribute_request" + examples: + ticket_type_attribute_created: + summary: Ticket Type Attribute created + value: + name: Attribute Title + description: Attribute Description + data_type: string + required_to_create: false + "/ticket_types/{ticket_type_id}/attributes/{id}": + put: + summary: Update an existing attribute for a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_type_id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + - name: id + in: path + required: true + description: The unique identifier for the ticket type attribute which is + given by Intercom. + schema: + type: string + tags: + - Ticket Type Attributes + description: You can update an existing attribute for a ticket type. + operationId: updateTicketTypeAttribute + responses: + '200': + description: Ticket Type Attribute updated + content: + application/json: + examples: + Ticket Type Attribute updated: + value: + type: ticket_type_attribute + id: '215' + workspace_id: this_is_an_id604_that_should_be_at_least_ + name: name + description: New Attribute Description + data_type: string + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 83 + archived: false + created_at: 1719493013 + updated_at: 1719493014 + schema: + "$ref": "#/components/schemas/ticket_type_attribute" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6e45414c-e627-4769-bdbd-d51f2c19e1e9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_type_attribute_request" + examples: + ticket_type_attribute_updated: + summary: Ticket Type Attribute updated + value: + description: New Attribute Description + "/ticket_types": + get: + summary: List all ticket types + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Ticket Types + operationId: listTicketTypes + description: You can get a list of all ticket types for a workspace. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: ticket_type + id: '85' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id608_that_should_be_at_least_ + archived: false + created_at: 1719493014 + updated_at: 1719493014 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '218' + workspace_id: this_is_an_id608_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 85 + archived: false + created_at: 1719493014 + updated_at: 1719493014 + - type: ticket_type_attribute + id: '220' + workspace_id: this_is_an_id608_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 85 + archived: false + created_at: 1719493014 + updated_at: 1719493014 + - type: ticket_type_attribute + id: '219' + workspace_id: this_is_an_id608_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 85 + archived: false + created_at: 1719493014 + updated_at: 1719493014 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 50823491-2ab1-4b84-9700-2d92c4f367fd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Ticket Types + operationId: createTicketType + description: "You can create a new ticket type.\n> \U0001F4D8 Creating ticket + types.\n>\n> Every ticket type will be created with two default attributes: + _default_title_ and _default_description_.\n> For the `icon` propery, use + an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + responses: + '200': + description: Ticket type created + content: + application/json: + examples: + Ticket type created: + value: + type: ticket_type + id: '88' + name: Customer Issue + description: Customer Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id612_that_should_be_at_least_ + archived: false + created_at: 1719493016 + updated_at: 1719493016 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '227' + workspace_id: this_is_an_id612_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 88 + archived: false + created_at: 1719493016 + updated_at: 1719493016 + - type: ticket_type_attribute + id: '228' + workspace_id: this_is_an_id612_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 88 + archived: false + created_at: 1719493016 + updated_at: 1719493016 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7c4784fe-d3e4-4182-b9c4-918bdf253eef + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_type_request" + examples: + ticket_type_created: + summary: Ticket type created + value: + name: Customer Issue + description: Customer Report Template + icon: "\U0001F39F️" + category: Customer + "/ticket_types/{id}": + get: + summary: Retrieve a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Types + operationId: getTicketType + description: You can fetch the details of a single ticket type. + responses: + '200': + description: Ticket type found + content: + application/json: + examples: + Ticket type found: + value: + type: ticket_type + id: '90' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id616_that_should_be_at_least_ + archived: false + created_at: 1719493017 + updated_at: 1719493017 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '232' + workspace_id: this_is_an_id616_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 90 + archived: false + created_at: 1719493017 + updated_at: 1719493017 + - type: ticket_type_attribute + id: '234' + workspace_id: this_is_an_id616_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 90 + archived: false + created_at: 1719493017 + updated_at: 1719493017 + - type: ticket_type_attribute + id: '233' + workspace_id: this_is_an_id616_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 90 + archived: false + created_at: 1719493017 + updated_at: 1719493017 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b0100f38-119c-4e30-8560-a25561d97c66 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Types + operationId: updateTicketType + description: "\nYou can update a ticket type.\n\n> \U0001F4D8 Updating a ticket + type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + responses: + '200': + description: Ticket type updated + content: + application/json: + examples: + Ticket type updated: + value: + type: ticket_type + id: '92' + name: Bug Report 2 + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id620_that_should_be_at_least_ + archived: false + created_at: 1719493018 + updated_at: 1719493018 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '238' + workspace_id: this_is_an_id620_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 92 + archived: false + created_at: 1719493018 + updated_at: 1719493018 + - type: ticket_type_attribute + id: '240' + workspace_id: this_is_an_id620_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 92 + archived: false + created_at: 1719493018 + updated_at: 1719493018 + - type: ticket_type_attribute + id: '239' + workspace_id: this_is_an_id620_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 92 + archived: false + created_at: 1719493018 + updated_at: 1719493018 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 2b0554fe-ba10-41d4-ab7b-715c2b7b8e47 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_type_request" + examples: + ticket_type_updated: + summary: Ticket type updated + value: + name: Bug Report 2 + "/tickets/{id}/reply": + post: + summary: Reply to a ticket + operationId: replyTicket + description: You can reply to a ticket with a message from an admin or on behalf + of a contact, or with a note for admins. + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + schema: + title: Ticket ID + type: string + description: The id of the ticket to target. + example: '123' + tags: + - Tickets + responses: + '400': + description: User reply + content: + application/json: + examples: + User reply: + value: + type: error.list + request_id: b8b42c55-347c-4704-b4c1-92220c01f4ac + errors: + - code: parameter_mismatch + message: User replies are not allowed on Backoffice tickets + schema: + "$ref": "#/components/schemas/error" + '200': + description: Admin quick_reply reply + content: + application/json: + examples: + Admin note reply: + value: + type: ticket_part + id: '122' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
    • +
  • Tea
    • +
  • Milk
    • +
+

An Ordered HTML List

+
    +
  1. Coffee
    2. +
  2. Tea
    3. +
  3. Milk
    4. +
+ created_at: 1719493024 + updated_at: 1719493024 + author: + id: '991267829' + type: admin + name: Ciaran375 Lee + email: admin375@email.com + attachments: [] + redacted: false + Admin quick_reply reply: + value: + type: ticket_part + id: '124' + part_type: quick_reply + created_at: 1719493029 + updated_at: 1719493029 + author: + id: '991267834' + type: admin + name: Ciaran379 Lee + email: admin379@email.com + attachments: [] + redacted: false + schema: + "$ref": "#/components/schemas/ticket_reply" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: c23e8dab-6102-483c-bb1b-c62923be35ab + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: bb012854-cca8-4fa7-972e-6c38204e8294 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/contact_reply_ticket_request" + - "$ref": "#/components/schemas/admin_reply_ticket_request" + examples: + user_reply: + summary: User reply + value: + message_type: comment + type: user + intercom_user_id: 667d619d8a68186f43bafe82 + body: Thanks again :) + admin_note_reply: + summary: Admin note reply + value: + message_type: note + type: admin + admin_id: 991267829 + body: "

An Unordered HTML List

  • Coffee
    • + \
  • Tea
  • Milk

An Ordered HTML List

+ \
  1. Coffee
  2. Tea
  3. Milk
+ \ " + admin_quick_reply_reply: + summary: Admin quick_reply reply + value: + message_type: quick_reply + type: admin + admin_id: 991267834 + reply_options: + - text: 'Yes' + uuid: 22d6d1f4-1a19-41d0-94c2-e54031f78aca + - text: 'No' + uuid: fbc3dbe0-ec0c-4fb6-826d-e19127191906 + not_found: + summary: Not found + value: + message_type: comment + type: user + intercom_user_id: 667d61a68a68186f43bafe85 + body: Thanks again :) + "/tickets/{ticket_id}/tags": + post: + summary: Add tag to a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + tags: + - Tags + - Tickets + operationId: attachTagToTicket + description: You can tag a specific ticket. This will return a tag object for + the tag that was added to the ticket. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '134' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Ticket not found + content: + application/json: + examples: + Ticket not found: + value: + type: error.list + request_id: e11d8f55-82fe-4c0d-b4c6-6f22c6a694e9 + errors: + - code: ticket_not_found + message: Ticket not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a502f48f-c80d-48fd-bea5-cafe7e24d9f9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - admin_id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '780' + examples: + successful: + summary: successful + value: + id: 134 + admin_id: 991267844 + ticket_not_found: + summary: Ticket not found + value: + id: 135 + admin_id: 991267847 + "/tickets/{ticket_id}/tags/{id}": + delete: + summary: Remove tag from a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string + tags: + - Tags + - Tickets + operationId: detachTagFromTicket + description: You can remove tag from a specific ticket. This will return a tag + object for the tag that was removed from the ticket. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '137' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Ticket not found: + value: + type: error.list + request_id: ffa08bb4-3994-4132-b9e3-14837e0723e8 + errors: + - code: ticket_not_found + message: Ticket not found + Tag not found: + value: + type: error.list + request_id: d2385995-502c-4c03-bf4b-93ef3d24037b + errors: + - code: tag_not_found + message: Tag not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0d3be117-0a9e-4e88-9a05-4fdd7f93d7bc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - admin_id + properties: + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '123' + examples: + successful: + summary: successful + value: + admin_id: 991267853 + ticket_not_found: + summary: Ticket not found + value: + admin_id: 991267856 + tag_not_found: + summary: Tag not found + value: + admin_id: 991267859 + "/tickets": + post: + summary: Create a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tickets + description: You can create a new ticket. + operationId: createTicket + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: ticket + id: '489' + ticket_id: '48' + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: submitted + ticket_type: + type: ticket_type + id: '106' + name: my-ticket-type-15 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id648_that_should_be_at_least_ + archived: false + created_at: 1719493047 + updated_at: 1719493047 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '252' + workspace_id: this_is_an_id648_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 106 + archived: false + created_at: 1719493047 + updated_at: 1719493047 + - type: ticket_type_attribute + id: '253' + workspace_id: this_is_an_id648_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 106 + archived: false + created_at: 1719493047 + updated_at: 1719493047 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61b78a68186f43bafe8d + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493048 + updated_at: 1719493048 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '125' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493048 + updated_at: 1719493048 + author: + id: '991267871' + type: bot + name: Operator + email: operator+this_is_an_id648_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 745c921a-7c5a-40d4-ab28-6d28a8d2ed47 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_request" + examples: + successful_response: + summary: Successful response + value: + ticket_type_id: 106 + contacts: + - id: 667d61b78a68186f43bafe8d + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + "/tickets/{id}": + put: + summary: Update a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom + schema: + type: string + tags: + - Tickets + operationId: updateTicket + description: You can update a ticket. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: ticket + id: '490' + ticket_id: '49' + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: in_progress + ticket_type: + type: ticket_type + id: '108' + name: my-ticket-type-17 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id652_that_should_be_at_least_ + archived: false + created_at: 1719493050 + updated_at: 1719493050 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '257' + workspace_id: this_is_an_id652_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 108 + archived: false + created_at: 1719493050 + updated_at: 1719493050 + - type: ticket_type_attribute + id: '258' + workspace_id: this_is_an_id652_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 108 + archived: false + created_at: 1719493050 + updated_at: 1719493050 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61bb8a68186f43bafe8e + external_id: cd63b6b5-ea75-4ad9-b72c-9d7a647baf08 + admin_assignee_id: '991267885' + team_assignee_id: '0' + created_at: 1719493051 + updated_at: 1719493054 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '126' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493051 + updated_at: 1719493051 + author: + id: '991267883' + type: admin + name: Ciaran419 Lee + email: admin419@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '127' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '128' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '129' + part_type: ticket_state_updated_by_admin + ticket_state: in_progress + previous_ticket_state: submitted + created_at: 1719493053 + updated_at: 1719493053 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '130' + part_type: assignment + created_at: 1719493054 + updated_at: 1719493054 + assigned_to: + type: admin + id: '991267885' + author: + id: '991267883' + type: admin + name: Ciaran419 Lee + email: admin419@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '131' + part_type: snoozed + created_at: 1719493054 + updated_at: 1719493054 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 6 + open: true + snoozed_until: 1719590400 + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: In progress + ticket_state_external_label: In progress + schema: + "$ref": "#/components/schemas/ticket" + '404': + description: Assignee not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 809aceaa-c073-4e2a-96c3-a25e15576946 + errors: + - code: assignee_not_found + message: Assignee not found + Assignee not found: + value: + type: error.list + request_id: 639b5b51-1eb9-4c06-8de4-d9b0e30fff05 + errors: + - code: assignee_not_found + message: Assignee not found + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e5202025-e8f9-400a-9107-192ae8bfd50c + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_request" + examples: + successful_response: + summary: Successful response + value: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '991267883' + assignee_id: '991267885' + open: true + snoozed_until: 1673609604 + admin_not_found: + summary: Admin not found + value: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '123' + assignee_id: '991267893' + assignee_not_found: + summary: Assignee not found + value: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '991267899' + assignee_id: '456' + get: + summary: Retrieve a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom. + schema: + type: string + tags: + - Tickets + operationId: getTicket + description: You can fetch the details of a single ticket. + responses: + '200': + description: Ticket found + content: + application/json: + examples: + Ticket found: + value: + type: ticket + id: '493' + ticket_id: '52' + ticket_attributes: + _default_title_: attribute_value + _default_description_: + ticket_state: submitted + ticket_type: + type: ticket_type + id: '112' + name: my-ticket-type-21 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id660_that_should_be_at_least_ + archived: false + created_at: 1719493060 + updated_at: 1719493060 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '268' + workspace_id: this_is_an_id660_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 112 + archived: false + created_at: 1719493060 + updated_at: 1719493060 + - type: ticket_type_attribute + id: '269' + workspace_id: this_is_an_id660_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 112 + archived: false + created_at: 1719493060 + updated_at: 1719493060 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61c48a68186f43bafe91 + external_id: '038050f6-d917-4b9d-89cb-539b1d371172' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493061 + updated_at: 1719493061 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '134' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493061 + updated_at: 1719493061 + author: + id: '991267912' + type: admin + name: Ciaran445 Lee + email: admin445@email.com + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e7ba89f2-3bc8-4fc3-97bc-56f62f342680 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/tickets/search": + post: + summary: Search tickets + operationId: searchTickets + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tickets + description: | + You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + + To search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`. + + This will accept a query object in the body which will define your filters. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiples there can be: + - There's a limit of max 2 nested filters + - There's a limit of max 15 filters for each AND or OR group + + ### Accepted Fields + + Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foobar"`). + + | Field | Type | + | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + | id | String | + | created_at | Date (UNIX timestamp) | + | updated_at | Date (UNIX timestamp) | + | _default_title_ | String | + | _default_description_ | String | + | category | String | + | ticket_type_id | String | + | contact_ids | String | + | teammate_ids | String | + | admin_assignee_id | String | + | team_assignee_id | String | + | open | Boolean | + | state | String | + | snoozed_until | Date (UNIX timestamp) | + | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + + ### Accepted Operators + + {% admonition type="info" name="Searching based on `created_at`" %} + You may use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :----------------------------- | :----------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In Shortcut for `OR` queries Values most be in Array | + | NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | + | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: ticket.list + pages: + type: pages + page: 1 + per_page: 5 + total_pages: 1 + total_count: 1 + tickets: + - type: ticket + id: '494' + ticket_id: '53' + ticket_attributes: + _default_title_: attribute_value + _default_description_: + ticket_state: submitted + ticket_type: + type: ticket_type + id: '117' + name: my-ticket-type-26 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id667_that_should_be_at_least_ + archived: false + created_at: 1719493065 + updated_at: 1719493065 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '279' + workspace_id: this_is_an_id667_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 117 + archived: false + created_at: 1719493065 + updated_at: 1719493065 + - type: ticket_type_attribute + id: '280' + workspace_id: this_is_an_id667_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 117 + archived: false + created_at: 1719493065 + updated_at: 1719493065 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61c98a68186f43bafe92 + external_id: 6895b33e-2768-4611-908e-da6632dfc8ea + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493065 + updated_at: 1719493066 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '135' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493066 + updated_at: 1719493066 + author: + id: '991267940' + type: admin + name: Ciaran472 Lee + email: admin472@email.com + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket_list" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: created_at + operator: ">" + value: '1306054154' + pagination: + per_page: 5 + "/visitors": + put: + summary: Update a visitor + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Visitors + operationId: updateVisitor + description: | + Sending a PUT request to `/visitors` will result in an update of an existing Visitor. + + **Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body. + + **Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: visitor + id: 667d61cc8a68186f43bafe95 + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: + name: Gareth Bale + pseudonym: Indigo Ghost + avatar: + type: avatar + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png + app_id: this_is_an_id671_that_should_be_at_least_ + companies: + type: company.list + companies: [] + location_data: {} + last_request_at: + created_at: 1719493068 + remote_created_at: 1719493068 + signed_up_at: 1719493068 + updated_at: 1719493068 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: [] + owner_id: + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + custom_attributes: {} + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: + schema: + "$ref": "#/components/schemas/visitor" + '404': + description: visitor Not Found + content: + application/json: + examples: + visitor Not Found: + value: + type: error.list + request_id: 1f35dc86-17d2-4bfe-8cb1-9afa74adc24c + errors: + - code: not_found + message: Visitor Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 82df3971-fb7c-410d-a919-e8bc1b3d991a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_visitor_request" + examples: + successful: + summary: successful + value: + id: 667d61cc8a68186f43bafe95 + name: Gareth Bale + visitor_not_found: + summary: visitor Not Found + value: + user_id: fail + name: Christian Fail + get: + summary: Retrieve a visitor with User ID + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: user_id + in: query + description: The user_id of the Visitor you want to retrieve. + required: true + schema: + type: string + tags: + - Visitors + operationId: retrieveVisitorWithUserId + description: You can fetch the details of a single visitor. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: visitor + id: 667d61ce8a68186f43bafe9b + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: + name: + pseudonym: + avatar: + type: avatar + image_url: + app_id: this_is_an_id677_that_should_be_at_least_ + companies: + type: company.list + companies: [] + location_data: {} + last_request_at: + created_at: 1719493070 + remote_created_at: 1719493070 + signed_up_at: 1719493070 + updated_at: 1719493070 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: [] + owner_id: + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + custom_attributes: {} + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: + schema: + "$ref": "#/components/schemas/visitor" + '404': + description: Visitor not found + content: + application/json: + examples: + Visitor not found: + value: + type: error.list + request_id: 7359afef-98f5-4b22-9de7-902f7a214729 + errors: + - code: not_found + message: Visitor Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 25dace4f-4916-492c-823b-f0cca227dff0 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/visitors/convert": + post: + summary: Convert a visitor + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Visitors + operationId: convertVisitor + description: "You can merge a Visitor to a Contact of role type `lead` or `user`.\n\n> + \U0001F4D8 What happens upon a visitor being converted?\n>\n> If the User + exists, then the Visitor will be merged into it, the Visitor deleted and the + User returned. If the User does not exist, the Visitor will be converted to + a User, with the User identifiers replacing it's Visitor identifiers.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d61d08a68186f43bafea2 + workspace_id: this_is_an_id683_that_should_be_at_least_ + external_id: + role: user + email: foo@bar.com + phone: + name: + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719493072 + updated_at: 1719493072 + signed_up_at: 1719493072 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: fe1a587a-e682-4a96-bd30-ea08b726e6fa + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/convert_visitor_request" + examples: + successful: + summary: successful + value: + visitor: + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + user: + email: foo@bar.com + type: user +components: + schemas: + activity_log: + title: Activity Log + type: object + description: Activities performed by Admins. + nullable: true + properties: + id: + type: string + description: The id representing the activity. + example: '6' + performed_by: + type: object + description: Details about the Admin involved in the activity. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + email: + type: string + description: The email of the admin. + example: john@example.com + ip: + type: string + description: The IP address of the admin. + example: 198.51.100.255 + metadata: + "$ref": "#/components/schemas/activity_log_metadata" + created_at: + type: integer + format: date-time + description: The time the activity was created. + example: 1671028894 + activity_type: + type: string + enum: + - admin_assignment_limit_change + - admin_away_mode_change + - admin_deletion + - admin_deprovisioned + - admin_impersonation_end + - admin_impersonation_start + - admin_invite_change + - admin_invite_creation + - admin_invite_deletion + - admin_login_failure + - admin_login_success + - admin_logout + - admin_password_reset_request + - admin_password_reset_success + - admin_permission_change + - admin_provisioned + - admin_two_factor_auth_change + - admin_unauthorized_sign_in_method + - app_admin_join + - app_authentication_method_change + - app_data_deletion + - app_data_export + - app_google_sso_domain_change + - app_identity_verification_change + - app_name_change + - app_outbound_address_change + - app_package_installation + - app_package_token_regeneration + - app_package_uninstallation + - app_team_creation + - app_team_deletion + - app_team_membership_modification + - app_timezone_change + - app_webhook_creation + - app_webhook_deletion + - articles_in_messenger_enabled_change + - bulk_delete + - bulk_export + - campaign_deletion + - campaign_state_change + - conversation_part_deletion + - conversation_topic_change + - conversation_topic_creation + - conversation_topic_deletion + - help_center_settings_change + - inbound_conversations_change + - inbox_access_change + - message_deletion + - message_state_change + - messenger_look_and_feel_change + - messenger_search_required_change + - messenger_spaces_change + - office_hours_change + - role_change + - role_creation + - role_deletion + - ruleset_activation_title_preview + - ruleset_creation + - ruleset_deletion + - search_browse_enabled_change + - search_browse_required_change + - seat_change + - seat_revoke + - security_settings_change + - temporary_expectation_change + - upfront_email_collection_change + - welcome_message_change + example: app_name_change + activity_description: + type: string + description: A sentence or two describing the activity. + example: Admin updated the app's name to "My App". + activity_log_list: + title: Paginated Response + type: object + description: A paginated list of activity logs. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `activity_log.list`. + example: activity_log.list + pages: + "$ref": "#/components/schemas/cursor_pages" + activity_logs: + type: array + description: An array of activity logs + items: + "$ref": "#/components/schemas/activity_log" + activity_log_metadata: + title: Activity Log Metadata + type: object + description: Additional data provided about Admin activity. + nullable: true + properties: + sign_in_method: + type: string + nullable: true + description: The way the admin signed in. + example: email_password + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + away_mode: + type: boolean + nullable: true + description: The away mode status which is set to true when away and false + when returned. + example: true + away_status_reason: + type: string + nullable: true + description: The reason the Admin is away. + example: "\U0001F60C On a break" + reassign_conversations: + type: boolean + nullable: true + description: Indicates if conversations should be reassigned while an Admin + is away. + example: false + source: + type: string + nullable: true + description: The action that initiated the status change. + example: 'admin update from web - Admin id: 93' + auto_changed: + type: string + nullable: true + description: Indicates if the status was changed automatically or manually. + example: false + update_by: + type: integer + nullable: true + description: The ID of the Admin who initiated the activity. + example: 93 + update_by_name: + type: string + nullable: true + description: The name of the Admin who initiated the activity. + example: Joe Bloggs + addressable_list: + title: Addressable List + type: object + nullable: false + description: A list used to access other resources from a parent model. + properties: + type: + type: string + format: uri + description: The addressable object type + example: note + id: + type: string + description: The id of the addressable object + example: '123' + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" + admin: + title: Admin + type: object + x-tags: + - Admins + description: Admins are teammate accounts that have access to a workspace. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + name: + type: string + description: The name of the admin. + example: Hoban Washburne + email: + type: string + description: The email of the admin. + example: wash@serenity.io + job_title: + type: string + description: The job title of the admin. + example: Philosopher + away_mode_enabled: + type: boolean + description: Identifies if this admin is currently set in away mode. + example: false + away_mode_reassign: + type: boolean + description: Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + example: false + has_inbox_seat: + type: boolean + description: Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + example: true + team_ids: + type: array + description: This object represents the avatar associated with the admin. + example: + - 814865 + items: + type: integer + avatar: + type: string + format: uri + nullable: true + description: Image for the associated team or teammate + example: https://picsum.photos/200/300 + team_priority_level: + "$ref": "#/components/schemas/team_priority_level" + admin_list: + title: Admins + type: object + description: A list of admins associated with a given workspace. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin.list`. + example: admin.list + admins: + type: array + description: A list of admins associated with a given workspace. + items: + "$ref": "#/components/schemas/admin" + admin_priority_level: + title: Admin Priority Level + type: object + nullable: true + description: Admin priority levels for the team + properties: + primary_admin_ids: + type: array + description: The primary admin ids for the team + nullable: true + example: + - 493881 + items: + type: integer + secondary_admin_ids: + type: array + description: The secondary admin ids for the team + nullable: true + example: + - 814865 + items: + type: integer + admin_reply_conversation_request: + title: Admin Reply + type: object + description: Payload of the request to reply on behalf of an admin + properties: + message_type: + type: string + enum: + - comment + - note + type: + type: string + enum: + - admin + example: admin + body: + type: string + description: The text body of the reply. Notes accept some HTML formatting. + Must be present for comment and note message types. + example: Hello there! + admin_id: + type: string + description: The id of the admin who is authoring the comment. + example: '3156780' + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + attachment_files: + type: array + description: A list of files that will be added as attachments. You can + include up to 10 files + items: + "$ref": "#/components/schemas/conversation_attachment_files" + maxItems: 10 + required: + - message_type + - type + - admin_id + admin_reply_ticket_request: + title: Admin Reply on ticket + type: object + description: Payload of the request to reply on behalf of an admin + properties: + message_type: + type: string + enum: + - comment + - note + - quick_reply + example: comment + type: + type: string + enum: + - admin + example: admin + body: + type: string + description: The text body of the reply. Notes accept some HTML formatting. + Must be present for comment and note message types. + example: Hello there! + admin_id: + type: string + description: The id of the admin who is authoring the comment. + example: '3156780' + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + reply_options: + title: Quick Reply Options + type: array + description: The quick reply options to display. Must be present for quick_reply + message types. + items: + title: Quick Reply Option + type: object + properties: + text: + type: string + description: The text to display in this quick reply option. + uuid: + type: string + format: uuid + description: A unique identifier for this quick reply option. This + value will be available within the metadata of the comment ticket + part that is created when a user clicks on this reply option. + required: + - text + - uuid + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + required: + - message_type + - type + - admin_id + admin_with_app: + title: Admin + type: object + description: Admins are the teammate accounts that have access to a workspace + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + name: + type: string + description: The name of the admin. + example: Hoban Washburne + email: + type: string + description: The email of the admin. + example: wash@serenity.io + job_title: + type: string + description: The job title of the admin. + example: Philosopher + away_mode_enabled: + type: boolean + description: Identifies if this admin is currently set in away mode. + example: false + away_mode_reassign: + type: boolean + description: Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + example: false + has_inbox_seat: + type: boolean + description: Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + example: true + team_ids: + type: array + description: This is a list of ids of the teams that this admin is part + of. + example: + - 814865 + items: + type: integer + avatar: + type: object + description: This object represents the avatar associated with the admin. + properties: + type: + type: string + description: This is a string that identifies the type of the object. + It will always have the value `avatar`. + default: avatar + example: avatar + image_url: + type: string + format: uri + nullable: true + description: This object represents the avatar associated with the admin. + example: https://example.com/avatar.png + email_verified: + type: boolean + description: Identifies if this admin's email is verified. + nullable: true + example: true + app: + "$ref": "#/components/schemas/app" + nullable: true + description: App that the admin belongs to. + ai_agent: + title: AI Agent + type: object + x-tags: + - Ai Agent + description: Data related to AI Agent involvement in the conversation. + properties: + source_type: + type: string + description: The type of the source that triggered AI Agent involvement + in the conversation. + enum: + - essentials_plan_setup + - profile + - workflow + - workflow_preview + - fin_preview + example: workflow + source_title: + type: string + description: The title of the source that triggered AI Agent involvement + in the conversation. If this is `essentials_plan_setup` then it will return + `null`. + example: My AI Workflow + nullable: true + last_answer_type: + type: string + description: The type of the last answer delivered by AI Agent. If no answer + was delivered then this will return `null` + enum: + - + - ai_answer + - custom_answer + example: ai_answer + nullable: true + resolution_state: + type: string + description: The resolution state of AI Agent. If no AI or custom answer + has been delivered then this will return `null`. + enum: + - assumed_resolution + - confirmed_resolution + - routed_to_team + - abandoned + - + example: assumed_resolution + nullable: true + rating: + type: integer + description: The customer satisfaction rating given to AI Agent, from 1-5. + example: 4 + nullable: true + rating_remark: + type: string + description: The customer satisfaction rating remark given to AI Agent. + example: Very helpful! + nullable: true + content_sources: + "$ref": "#/components/schemas/content_sources_list" + app: + title: App + type: object + description: App is a workspace on Intercom + nullable: true + properties: + type: + type: string + description: '' + default: app + example: app + id_code: + type: string + description: The id of the app. + example: xyz789 + name: + type: string + description: The name of the app. + example: ACME + region: + type: string + description: The Intercom region the app is located in. + example: US + timezone: + type: string + description: The timezone of the region where the app is located. + example: America/Los_Angeles + created_at: + type: integer + description: When the app was created. + example: 1671465577 + identity_verification: + type: boolean + description: Whether or not the app uses identity verification. + example: false + article: + title: Article + type: object + x-tags: + - Articles + description: The Articles API is a central place to gather all information and + take actions on your articles. Articles can live within collections and sections, + or alternatively they can stand alone. + properties: + statistics: + nullable: true + "$ref": "#/components/schemas/article_statistics" + allOf: + - "$ref": "#/components/schemas/article_list_item" + article_content: + title: Article Content + type: object + description: The Content of an Article. + nullable: true + properties: + type: + type: string + description: The type of object - `article_content` . + enum: + - + - article_content + example: article_content + nullable: true + title: + type: string + description: The title of the article. + example: How to create a new article + description: + type: string + description: The description of the article. + example: This article will show you how to create a new article. + body: + type: string + description: The body of the article. + example: This is the body of the article. + author_id: + type: integer + description: The ID of the author of the article. + example: '5017691' + state: + type: string + description: Whether the article is `published` or is a `draft` . + enum: + - published + - draft + example: draft + created_at: + type: integer + format: date-time + description: The time when the article was created (seconds). + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated (seconds). + example: 1663597260 + url: + type: string + description: The URL of the article. + example: http://intercom.test/help/en/articles/3-default-language + article_list: + title: Articles + type: object + description: This will return a list of articles for the App. + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of articles. + example: 1 + data: + type: array + description: An array of Article objects + items: + "$ref": "#/components/schemas/article_list_item" + article_list_item: + title: Articles + type: object + x-tags: + - Articles + description: The data returned about your articles when you list them. + properties: + type: + type: string + description: The type of object - `article`. + enum: + - article + default: article + example: article + id: + type: string + description: The unique identifier for the article which is given by Intercom. + example: '6871119' + workspace_id: + type: string + description: The id of the workspace which the article belongs to. + example: hfi1bx4l + title: + type: string + description: The title of the article. For multilingual articles, this will + be the title of the default language's content. + example: Default language title + description: + type: string + nullable: true + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Default language description + body: + type: string + nullable: true + description: The body of the article in HTML. For multilingual articles, + this will be the body of the default language's content. + example: Default language body in html + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: '5017691' + state: + type: string + description: Whether the article is `published` or is a `draft`. For multilingual + articles, this will be the state of the default language's content. + enum: + - published + - draft + default: draft + example: published + created_at: + type: integer + format: date-time + description: The time when the article was created. For multilingual articles, + this will be the timestamp of creation of the default language's content + in seconds. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated. For multilingual + articles, this will be the timestamp of last update of the default language's + content in seconds. + example: 1672928610 + url: + type: string + nullable: true + description: The URL of the article. For multilingual articles, this will + be the URL of the default language's content. + example: http://intercom.test/help/en/articles/3-default-language + parent_id: + type: integer + nullable: true + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: '125685' + parent_ids: + type: array + description: The ids of the article's parent collections or sections. An + article without this field stands alone. + items: + type: integer + example: + - 18 + - 19 + parent_type: + type: string + nullable: true + description: The type of parent, which can either be a `collection` or `section`. + example: collection + default_locale: + type: string + description: The default locale of the help center. This field is only returned + for multilingual help centers. + example: en + translated_content: + nullable: true + "$ref": "#/components/schemas/article_translated_content" + article_search_highlights: + title: Article Search Highlights + type: object + x-tags: + - Articles + description: The highlighted results of an Article search. In the examples provided + my search query is always "my query". + properties: + article_id: + type: string + description: The ID of the corresponding article. + example: '123' + highlighted_title: + type: array + description: An Article title highlighted. + items: + type: object + description: A highlighted article title. + properties: + type: + type: string + description: The type of text - `highlight` or `plain`. + enum: + - highlight + - plain + example: 'The highlight is ' + text: + type: string + description: The text of the title. + example: my query + highlighted_summary: + type: array + description: An Article description and body text highlighted. + items: + type: array + description: An array containing the highlighted summary text split into + chunks of plain and highlighted text. + items: + type: object + description: An instance of highlighted summary text. + properties: + type: + type: string + description: The type of text - `highlight` or `plain`. + enum: + - highlight + - plain + example: 'How to highlight ' + text: + type: string + description: The text of the title. + example: my query + article_search_response: + title: Article Search Response + type: object + x-tags: + - Articles + description: The results of an Article search + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + total_count: + type: integer + description: The total number of Articles matching the search query + example: 5 + data: + type: object + description: An object containing the results of the search. + properties: + articles: + type: array + description: An array of Article objects + items: + "$ref": "#/components/schemas/article" + highlights: + type: array + description: A corresponding array of highlighted Article content + items: + "$ref": "#/components/schemas/article_search_highlights" + pages: + "$ref": "#/components/schemas/cursor_pages" + article_statistics: + title: Article Statistics + type: object + description: The statistics of an article. + nullable: true + properties: + type: + type: string + description: The type of object - `article_statistics`. + enum: + - article_statistics + default: article_statistics + example: article_statistics + views: + type: integer + description: The number of total views the article has received. + example: 10 + conversions: + type: integer + description: The number of conversations started from the article. + example: 0 + reactions: + type: integer + description: The number of total reactions the article has received. + example: 10 + happy_reaction_percentage: + type: number + format: float + description: The percentage of happy reactions the article has received + against other types of reaction. + example: 40.0 + neutral_reaction_percentage: + type: number + format: float + description: The percentage of neutral reactions the article has received + against other types of reaction. + example: 40.0 + sad_reaction_percentage: + type: number + format: float + description: The percentage of sad reactions the article has received against + other types of reaction. + example: 20.0 + article_translated_content: + title: Article Translated Content + type: object + description: The Translated Content of an Article. The keys are the locale codes + and the values are the translated content of the article. + nullable: true + properties: + type: + type: string + description: The type of object - article_translated_content. + enum: + - + - article_translated_content + example: article_translated_content + nullable: true + ar: + description: The content of the article in Arabic + "$ref": "#/components/schemas/article_content" + bg: + description: The content of the article in Bulgarian + "$ref": "#/components/schemas/article_content" + bs: + description: The content of the article in Bosnian + "$ref": "#/components/schemas/article_content" + ca: + description: The content of the article in Catalan + "$ref": "#/components/schemas/article_content" + cs: + description: The content of the article in Czech + "$ref": "#/components/schemas/article_content" + da: + description: The content of the article in Danish + "$ref": "#/components/schemas/article_content" + de: + description: The content of the article in German + "$ref": "#/components/schemas/article_content" + el: + description: The content of the article in Greek + "$ref": "#/components/schemas/article_content" + en: + description: The content of the article in English + "$ref": "#/components/schemas/article_content" + es: + description: The content of the article in Spanish + "$ref": "#/components/schemas/article_content" + et: + description: The content of the article in Estonian + "$ref": "#/components/schemas/article_content" + fi: + description: The content of the article in Finnish + "$ref": "#/components/schemas/article_content" + fr: + description: The content of the article in French + "$ref": "#/components/schemas/article_content" + he: + description: The content of the article in Hebrew + "$ref": "#/components/schemas/article_content" + hr: + description: The content of the article in Croatian + "$ref": "#/components/schemas/article_content" + hu: + description: The content of the article in Hungarian + "$ref": "#/components/schemas/article_content" + id: + description: The content of the article in Indonesian + "$ref": "#/components/schemas/article_content" + it: + description: The content of the article in Italian + "$ref": "#/components/schemas/article_content" + ja: + description: The content of the article in Japanese + "$ref": "#/components/schemas/article_content" + ko: + description: The content of the article in Korean + "$ref": "#/components/schemas/article_content" + lt: + description: The content of the article in Lithuanian + "$ref": "#/components/schemas/article_content" + lv: + description: The content of the article in Latvian + "$ref": "#/components/schemas/article_content" + mn: + description: The content of the article in Mongolian + "$ref": "#/components/schemas/article_content" + nb: + description: The content of the article in Norwegian + "$ref": "#/components/schemas/article_content" + nl: + description: The content of the article in Dutch + "$ref": "#/components/schemas/article_content" + pl: + description: The content of the article in Polish + "$ref": "#/components/schemas/article_content" + pt: + description: The content of the article in Portuguese (Portugal) + "$ref": "#/components/schemas/article_content" + ro: + description: The content of the article in Romanian + "$ref": "#/components/schemas/article_content" + ru: + description: The content of the article in Russian + "$ref": "#/components/schemas/article_content" + sl: + description: The content of the article in Slovenian + "$ref": "#/components/schemas/article_content" + sr: + description: The content of the article in Serbian + "$ref": "#/components/schemas/article_content" + sv: + description: The content of the article in Swedish + "$ref": "#/components/schemas/article_content" + tr: + description: The content of the article in Turkish + "$ref": "#/components/schemas/article_content" + vi: + description: The content of the article in Vietnamese + "$ref": "#/components/schemas/article_content" + pt-BR: + description: The content of the article in Portuguese (Brazil) + "$ref": "#/components/schemas/article_content" + zh-CN: + description: The content of the article in Chinese (China) + "$ref": "#/components/schemas/article_content" + zh-TW: + description: The content of the article in Chinese (Taiwan) + "$ref": "#/components/schemas/article_content" + assign_conversation_request: + title: Assign Conversation Request + type: object + description: Payload of the request to assign a conversation + properties: + message_type: + type: string + enum: + - assignment + example: assignment + type: + type: string + enum: + - admin + - team + example: admin + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '12345' + assignee_id: + type: string + description: The `id` of the `admin` or `team` which will be assigned the + conversation. A conversation can be assigned both an admin and a team.\nSet + `0` if you want this assign to no admin or team (ie. Unassigned). + example: '4324241' + body: + type: string + description: Optionally you can send a response in the conversation when + it is assigned. + example: Let me pass you over to one of my colleagues. + required: + - message_type + - type + - admin_id + - assignee_id + attach_contact_to_conversation_request: + title: Assign Conversation Request + type: object + description: Payload of the request to assign a conversation + properties: + admin_id: + type: string + description: The `id` of the admin who is adding the new participant. + example: '12345' + customer: + type: object + oneOf: + - title: Intercom User ID + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + example: 6329bd9ffe4e2e91dac76188 + customer: + "$ref": "#/components/schemas/customer_request" + required: + - intercom_user_id + - title: User ID + properties: + user_id: + type: string + description: The external_id you have defined for the contact who + is being added as a participant. + example: 6329bd9ffe4e2e91dac76188 + customer: + "$ref": "#/components/schemas/customer_request" + required: + - user_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being + added as a participant. + example: winstonsmith@truth.org + customer: + "$ref": "#/components/schemas/customer_request" + required: + - email + close_conversation_request: + title: Close Conversation Request + type: object + description: Payload of the request to close a conversation + properties: + message_type: + type: string + enum: + - close + example: close + type: + type: string + enum: + - admin + example: admin + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '12345' + body: + type: string + description: Optionally you can leave a message in the conversation to provide + additional context to the user and other teammates. + example: " This conversation is now closed!" + required: + - message_type + - type + - admin_id + collection: + title: Collection + type: object + x-tags: + - Help Center + description: Collections are top level containers for Articles within the Help + Center. + properties: + id: + type: string + description: The unique identifier for the collection which is given by + Intercom. + example: '6871119' + workspace_id: + type: string + description: The id of the workspace which the collection belongs to. + example: hfi1bx4l + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: Default language name + description: + type: string + nullable: true + description: The description of the collection. For multilingual help centers, + this will be the description of the collection for the default language. + example: Default language description + created_at: + type: integer + format: date-time + description: The time when the article was created (seconds). For multilingual + articles, this will be the timestamp of creation of the default language's + content. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated (seconds). For multilingual + articles, this will be the timestamp of last update of the default language's + content. + example: 1672928610 + url: + type: string + nullable: true + description: The URL of the collection. For multilingual help centers, this + will be the URL of the collection for the default language. + example: http://intercom.test/help/collection/name + icon: + type: string + nullable: true + description: The icon of the collection. + example: book-bookmark + order: + type: integer + description: The order of the section in relation to others sections within + a collection. Values go from `0` upwards. `0` is the default if there's + no order. + example: '1' + default_locale: + type: string + description: The default locale of the help center. This field is only returned + for multilingual help centers. + example: en + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it is the first + level collection. + example: '6871118' + help_center_id: + type: integer + nullable: true + description: The id of the help center the collection is in. + example: '123' + collection_list: + title: Collections + type: object + description: This will return a list of Collections for the App. + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of collections. + example: 1 + data: + type: array + description: An array of collection objects + items: + "$ref": "#/components/schemas/collection" + company: + title: Company + type: object + x-tags: + - Companies + description: Companies allow you to represent organizations using your product. + Each company will have its own description and be associated with contacts. + You can fetch, create, update and list companies. + properties: + type: + type: string + description: Value is `company` + enum: + - company + example: company + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + name: + type: string + description: The name of the company. + example: Blue Sun + app_id: + type: string + description: The Intercom defined code of the workspace the company is associated + to. + example: ecahpwf5 + plan: + type: object + properties: + type: + type: string + description: Value is always "plan" + example: plan + id: + type: string + description: The id of the plan + example: '269315' + name: + type: string + description: The name of the plan + example: Pro + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + remote_created_at: + type: integer + description: The time the company was created by you. + example: 1663597223 + created_at: + type: integer + description: The time the company was added in Intercom. + example: 1663597223 + updated_at: + type: integer + description: The last time the company was updated. + example: 1663597223 + last_request_at: + type: integer + description: The time the company last recorded making a request. + example: 1663597223 + size: + type: integer + description: The number of employees in the company. + example: 100 + website: + type: string + description: The URL for the company website. + example: https://www.intercom.com + industry: + type: string + description: The industry that the company operates in. + example: Software + monthly_spend: + type: integer + description: How much revenue the company generates for your business. + example: 100 + session_count: + type: integer + description: How many sessions the company has recorded. + example: 100 + user_count: + type: integer + description: The number of users in the company. + example: 100 + custom_attributes: + type: object + description: The custom attributes you have set on the company. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + tags: + type: object + description: The list of tags associated with the company + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + tags: + type: array + items: + items: + "$ref": "#/components/schemas/tag" + segments: + type: object + description: The list of segments associated with the company + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + segments: + type: array + items: + "$ref": "#/components/schemas/segment" + company_attached_contacts: + title: Company Attached Contacts + type: object + description: A list of Contact Objects + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + description: An array containing Contact Objects + items: + "$ref": "#/components/schemas/contact" + total_count: + type: integer + description: The total number of contacts + example: 100 + pages: + "$ref": "#/components/schemas/cursor_pages" + company_attached_segments: + title: Company Attached Segments + type: object + description: A list of Segment Objects + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + description: An array containing Segment Objects + items: + "$ref": "#/components/schemas/segment" + company_list: + title: Companies + type: object + description: This will return a list of companies for the App. + properties: + type: + type: string + description: The type of object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: The total number of companies. + example: 100 + data: + type: array + description: An array containing Company Objects. + items: + "$ref": "#/components/schemas/company" + company_scroll: + title: Company Scroll + type: object + description: Companies allow you to represent organizations using your product. + Each company will have its own description and be associated with contacts. + You can fetch, create, update and list companies. + nullable: true + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + items: + "$ref": "#/components/schemas/company" + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: The total number of companies + nullable: true + example: 100 + scroll_param: + type: string + description: The scroll parameter to use in the next request to fetch the + next page of results. + example: 25b649f7-4d33-4ef6-88f5-60e5b8244309 + contact: + title: Contact + type: object + x-tags: + - Contacts + description: Contact are the objects that represent your leads and users in + Intercom. + properties: + type: + type: string + description: The type of object. + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + workspace_id: + type: string + description: The id of the workspace which the contact belongs to. + example: ecahpwf5 + role: + type: string + description: The role of the contact. + example: user + email: + type: string + description: The contact's email. + example: joe@example.com + email_domain: + type: string + description: The contact's email domain. + example: example.com + phone: + type: string + nullable: true + description: The contacts phone. + example: "+1123456789" + formatted_phone: + type: string + nullable: true + description: The contacts phone number normalized to the E164 format + example: "+1123456789" + name: + type: string + nullable: true + description: The contacts name. + example: John Doe + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact. + example: 123 + has_hard_bounced: + type: boolean + description: Whether the contact has had an email sent to them hard bounce. + example: true + marked_email_as_spam: + type: boolean + description: Whether the contact has marked an email sent to them as spam. + example: true + unsubscribed_from_emails: + type: boolean + description: Whether the contact is unsubscribed from emails. + example: true + created_at: + type: integer + format: date-time + description: "(UNIX timestamp) The time when the contact was created." + example: 1571672154 + updated_at: + type: integer + format: date-time + description: "(UNIX timestamp) The time when the contact was last updated." + example: 1571672154 + signed_up_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time specified for when a contact signed + up." + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact was last seen (either + where the Intercom Messenger was installed or when specified manually)." + example: 1571672154 + last_replied_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last messaged in." + example: 1571672154 + last_contacted_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact was last messaged." + example: 1571672154 + last_email_opened_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last opened an + email." + example: 1571672154 + last_email_clicked_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last clicked a + link in an email." + example: 1571672154 + language_override: + type: string + nullable: true + description: A preferred language setting for the contact, used by the Intercom + Messenger even if their browser settings change. + example: en + browser: + type: string + nullable: true + description: The name of the browser which the contact is using. + example: Chrome + browser_version: + type: string + nullable: true + description: The version of the browser which the contact is using. + example: 80.0.3987.132 + browser_language: + type: string + nullable: true + description: The language set by the browser which the contact is using. + example: en-US + os: + type: string + nullable: true + description: The operating system which the contact is using. + example: Mac OS X + android_app_name: + type: string + nullable: true + description: The name of the Android app which the contact is using. + example: Intercom + android_app_version: + type: string + nullable: true + description: The version of the Android app which the contact is using. + example: 5.0.0 + android_device: + type: string + nullable: true + description: The Android device which the contact is using. + example: Pixel 3 + android_os_version: + type: string + nullable: true + description: The version of the Android OS which the contact is using. + example: '10' + android_sdk_version: + type: string + nullable: true + description: The version of the Android SDK which the contact is using. + example: '28' + android_last_seen_at: + type: integer + nullable: true + format: date-time + description: "(UNIX timestamp) The time when the contact was last seen on + an Android device." + example: 1571672154 + ios_app_name: + type: string + nullable: true + description: The name of the iOS app which the contact is using. + example: Intercom + ios_app_version: + type: string + nullable: true + description: The version of the iOS app which the contact is using. + example: 5.0.0 + ios_device: + type: string + nullable: true + description: The iOS device which the contact is using. + example: iPhone 11 + ios_os_version: + type: string + nullable: true + description: The version of iOS which the contact is using. + example: 13.3.1 + ios_sdk_version: + type: string + nullable: true + description: The version of the iOS SDK which the contact is using. + example: 13.3.1 + ios_last_seen_at: + type: integer + nullable: true + format: date-time + description: "(UNIX timestamp) The last time the contact used the iOS app." + example: 1571672154 + custom_attributes: + type: object + description: The custom attributes which are set for the contact. + avatar: + type: object + nullable: true + properties: + type: + type: string + description: The type of object + example: avatar + image_url: + type: string + format: uri + nullable: true + description: An image URL containing the avatar of a contact. + example: https://example.org/128Wash.jpg + tags: + "$ref": "#/components/schemas/contact_tags" + notes: + "$ref": "#/components/schemas/contact_notes" + companies: + "$ref": "#/components/schemas/contact_companies" + location: + "$ref": "#/components/schemas/contact_location" + social_profiles: + "$ref": "#/components/schemas/contact_social_profiles" + contact_archived: + title: Contact Archived + type: object + description: archived contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + archived: + type: boolean + description: Whether the contact is archived or not. + example: true + contact_attached_companies: + title: Contact Attached Companies + type: object + description: A list of Company Objects + properties: + type: + type: string + description: The type of object + enum: + - list + example: list + companies: + type: array + description: An array containing Company Objects + items: + "$ref": "#/components/schemas/company" + total_count: + type: integer + description: The total number of companies associated to this contact + example: 100 + pages: + "$ref": "#/components/schemas/pages_link" + contact_companies: + title: Contact companies + type: object + nullable: false + description: An object containing companies meta data about the companies that + a contact has. Up to 10 will be displayed here. Use the url to get more. + properties: + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/companies" + total_count: + type: integer + description: Int representing the total number of companyies attached to + this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_deleted: + title: Contact Deleted + type: object + description: deleted contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + deleted: + type: boolean + description: Whether the contact is deleted or not. + example: true + contact_list: + title: Contact List + type: object + description: Contacts are your users in Intercom. + properties: + type: + type: string + description: Always list + enum: + - list + example: list + data: + type: array + description: The list of contact objects + items: + "$ref": "#/components/schemas/contact" + total_count: + type: integer + description: A count of the total number of objects. + example: 100 + pages: + "$ref": "#/components/schemas/cursor_pages" + contact_location: + title: Contact Location + type: object + nullable: false + description: An object containing location meta data about a Intercom contact. + properties: + type: + type: string + nullable: true + description: Always location + example: location + country: + type: string + nullable: true + description: The country that the contact is located in + example: Ireland + region: + type: string + nullable: true + description: The overal region that the contact is located in + example: Dublin + city: + type: string + nullable: true + description: The city that the contact is located in + example: Dublin + contact_notes: + title: Contact notes + type: object + nullable: false + description: An object containing notes meta data about the notes that a contact + has. Up to 10 will be displayed here. Use the url to get more. + properties: + data: + type: array + description: This object represents the notes attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" + total_count: + type: integer + description: Int representing the total number of companyies attached to + this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_reference: + title: Contact Reference + type: object + description: reference to contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + contact_reply_base_request: + title: Contact Reply Base Object + type: object + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + attachment_urls: + title: Attachment URLs + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + required: + - message_type + - type + - body + contact_reply_conversation_request: + title: Contact Reply + oneOf: + - "$ref": "#/components/schemas/contact_reply_intercom_user_id_request" + - "$ref": "#/components/schemas/contact_reply_email_request" + - "$ref": "#/components/schemas/contact_reply_user_id_request" + contact_reply_email_request: + title: Email + type: object + description: Payload of the request to reply on behalf of a contact using their + `email` + properties: + email: + type: string + description: The email you have defined for the user. + attachment_files: + type: array + description: A list of files that will be added as attachments. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + required: + - email + contact_reply_intercom_user_id_request: + title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_files: + type: array + description: A list of files that will be added as attachments. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + required: + - intercom_user_id + contact_reply_ticket_email_request: + title: Email + type: object + description: Payload of the request to reply on behalf of a contact using their + `email` + properties: + email: + type: string + description: The email you have defined for the user. + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + required: + - email + contact_reply_ticket_intercom_user_id_request: + title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + required: + - intercom_user_id + contact_reply_ticket_request: + title: Contact Reply on ticket + oneOf: + - "$ref": "#/components/schemas/contact_reply_ticket_intercom_user_id_request" + - "$ref": "#/components/schemas/contact_reply_ticket_user_id_request" + - "$ref": "#/components/schemas/contact_reply_ticket_email_request" + contact_reply_ticket_user_id_request: + title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + user_id: + type: string + description: The external_id you have defined for the contact. + required: + - user_id + contact_reply_user_id_request: + title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_files: + type: array + description: A list of files that will be added as attachments. You can + include up to 10 files. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + maxItems: 10 + required: + - user_id + contact_segments: + title: Segments + type: object + description: A list of segments objects attached to a specific contact. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: Segment objects associated with the contact. + items: + "$ref": "#/components/schemas/segment" + contact_social_profiles: + title: Social Profile + type: object + nullable: false + description: An object containing social profiles that a contact has. + properties: + data: + type: array + description: A list of social profiles objects associated with the contact. + items: + "$ref": "#/components/schemas/social_profile" + contact_subscription_types: + title: Contact Subscription Types + type: object + nullable: false + description: An object containing Subscription Types meta data about the SubscriptionTypes + that a contact has. + properties: + data: + type: array + description: This object represents the subscriptions attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: Url to get more subscription type resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions" + total_count: + type: integer + description: Int representing the total number of subscription types attached + to this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_tags: + title: Contact Tags + type: object + nullable: true + description: An object containing tags meta data about the tags that a contact + has. Up to 10 will be displayed here. Use the url to get more. + properties: + data: + type: array + description: This object represents the tags attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: url to get more tag resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/tags" + total_count: + type: integer + description: Int representing the total number of tags attached to this + contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_unarchived: + title: Contact Unarchived + type: object + description: unarchived contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + archived: + type: boolean + description: Whether the contact is archived or not. + example: false + content_source: + title: Content Source + type: object + x-tags: + - AI Content Source + description: The content source used by AI Agent in the conversation. + properties: + content_type: + type: string + description: The type of the content source. + example: content_snippet + enum: + - file + - article + - external_content + - content_snippet + - workflow_connector_action + url: + type: string + description: The internal URL linking to the content source for teammates. + example: "/fin-ai-agent/content?content=content_snippet&id=3234924" + title: + type: string + description: The title of the content source. + example: My internal content snippet + locale: + type: string + description: The ISO 639 language code of the content source. + example: en + content_sources_list: + title: Content Source List + nullable: false + properties: + type: + type: string + enum: + - content_source.list + example: content_source.list + total_count: + type: integer + description: The total number of content sources used by AI Agent in the + conversation. + example: 1 + content_sources: + type: array + description: The content sources used by AI Agent in the conversation. + items: + "$ref": "#/components/schemas/content_source" + conversation: + title: Conversation + type: object + x-tags: + - Conversations + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + properties: + type: + type: string + description: Always conversation. + example: conversation + id: + type: string + description: The id representing the conversation. + example: '1295' + title: + type: string + nullable: true + description: The title given to the conversation. + example: Conversation Title + created_at: + type: integer + format: date-time + description: The time the conversation was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the conversation was updated. + example: 1663597260 + waiting_since: + type: integer + format: date-time + nullable: true + description: The last time a Contact responded to an Admin. In other words, + the time a customer started waiting for a response. Set to null if last + reply is from an Admin. + example: 1663597260 + snoozed_until: + type: integer + format: date-time + nullable: true + description: If set this is the time in the future when this conversation + will be marked as open. i.e. it will be in a snoozed state until this + time. i.e. it will be in a snoozed state until this time. + example: 1663597260 + open: + type: boolean + description: Indicates whether a conversation is open (true) or closed (false). + example: true + state: + type: string + enum: + - open + - closed + - snoozed + description: Can be set to "open", "closed" or "snoozed". + example: open + read: + type: boolean + description: Indicates whether a conversation has been read. + example: true + priority: + type: string + enum: + - priority + - not_priority + description: If marked as priority, it will return priority or else not_priority. + example: priority + admin_assignee_id: + type: integer + nullable: true + description: The id of the admin assigned to the conversation. If it's not + assigned to an admin it will return null. + example: 0 + team_assignee_id: + type: string + nullable: true + description: The id of the team assigned to the conversation. If it's not + assigned to a team it will return null. + example: '5017691' + tags: + "$ref": "#/components/schemas/tags" + conversation_rating: + "$ref": "#/components/schemas/conversation_rating" + source: + "$ref": "#/components/schemas/conversation_source" + contacts: + "$ref": "#/components/schemas/conversation_contacts" + teammates: + "$ref": "#/components/schemas/conversation_teammates" + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + first_contact_reply: + "$ref": "#/components/schemas/conversation_first_contact_reply" + sla_applied: + "$ref": "#/components/schemas/sla_applied" + statistics: + "$ref": "#/components/schemas/conversation_statistics" + conversation_parts: + "$ref": "#/components/schemas/conversation_parts" + linked_objects: + "$ref": "#/components/schemas/linked_object_list" + ai_agent_participated: + type: boolean + description: Indicates whether the AI Agent participated in the conversation. + example: true + ai_agent: + "$ref": "#/components/schemas/ai_agent" + nullable: true + conversation_attachment_files: + title: Conversation attachment files + type: object + description: Properties of the attachment files in a conversation part + properties: + content_type: + type: string + description: The content type of the file + example: application/json + data: + type: string + description: The base64 encoded file data. + example: ewogICJ0ZXN0IjogMQp9 + name: + type: string + description: The name of the file. + example: test.json + conversation_contacts: + title: Contacts + type: object + description: The list of contacts (users or leads) involved in this conversation. + This will only contain one customer unless more were added via the group conversation + feature. + properties: + type: + type: string + description: '' + enum: + - contact.list + example: contact.list + contacts: + type: array + description: The list of contacts (users or leads) involved in this conversation. + This will only contain one customer unless more were added via the group + conversation feature. + items: + "$ref": "#/components/schemas/contact_reference" + conversation_first_contact_reply: + title: First contact reply + type: object + nullable: true + description: An object containing information on the first users message. For + a contact initiated message this will represent the users original message. + properties: + created_at: + type: integer + format: date-time + description: '' + example: 1663597223 + type: + type: string + description: '' + example: conversation + url: + type: string + nullable: true + description: '' + example: https://developers.intercom.com/ + conversation_list: + title: Conversation List + type: object + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + properties: + type: + type: string + description: Always conversation.list + enum: + - conversation.list + example: conversation.list + conversations: + type: array + description: The list of conversation objects + items: + "$ref": "#/components/schemas/conversation" + total_count: + type: integer + description: A count of the total number of objects. + example: 12345 + pages: + "$ref": "#/components/schemas/cursor_pages" + conversation_part: + title: Conversation Part + type: object + description: A Conversation Part represents a message in the conversation. + properties: + type: + type: string + description: Always conversation_part + example: conversation_part + id: + type: string + description: The id representing the conversation part. + example: '3' + part_type: + type: string + description: The type of conversation part. + example: comment + body: + type: string + nullable: true + description: The message body, which may contain HTML. For Twitter, this + will show a generic message regarding why the body is obscured. + example: "

Okay!

" + created_at: + type: integer + format: date-time + description: The time the conversation part was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the conversation part was updated. + example: 1663597260 + notified_at: + type: integer + format: date-time + description: The time the user was notified with the conversation part. + example: 1663597260 + assigned_to: + "$ref": "#/components/schemas/reference" + nullable: true + description: The id of the admin that was assigned the conversation by this + conversation_part (null if there has been no change in assignment.) + author: + "$ref": "#/components/schemas/conversation_part_author" + attachments: + title: Conversation part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + external_id: + type: string + nullable: true + description: The external id of the conversation part + example: abcd1234 + redacted: + type: boolean + description: Whether or not the conversation part has been redacted. + example: false + conversation_part_author: + title: Conversation part author + type: object + description: The object who initiated the conversation, which can be a Contact, + Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. + For Twitter, this will be blank. + properties: + type: + type: string + description: The type of the author + example: admin + id: + type: string + description: The id of the author + example: '274' + name: + type: string + description: The name of the author + example: Operator + email: + type: string + format: email + description: The email of the author + example: operator+abcd1234@intercom.io + conversation_parts: + title: Conversation Parts + type: object + description: A list of Conversation Part objects for each part message in the + conversation. This is only returned when Retrieving a Conversation, and ignored + when Listing all Conversations. There is a limit of 500 parts. + properties: + type: + type: string + description: '' + enum: + - conversation_part.list + example: conversation_part.list + conversation_parts: + title: Conversation Parts + type: array + description: A list of Conversation Part objects for each part message in + the conversation. This is only returned when Retrieving a Conversation, + and ignored when Listing all Conversations. There is a limit of 500 parts. + items: + "$ref": "#/components/schemas/conversation_part" + total_count: + type: integer + description: '' + example: 2 + conversation_rating: + title: Conversation Rating + type: object + nullable: true + description: The Conversation Rating object which contains information on the + rating and/or remark added by a Contact and the Admin assigned to the conversation. + properties: + rating: + type: integer + description: The rating, between 1 and 5, for the conversation. + example: 5 + remark: + type: string + description: An optional field to add a remark to correspond to the number + rating + example: '' + created_at: + type: integer + format: date-time + description: The time the rating was requested in the conversation being + rated. + example: 1671028894 + contact: + "$ref": "#/components/schemas/contact_reference" + teammate: + "$ref": "#/components/schemas/reference" + conversation_source: + title: Conversation source + type: object + description: The Conversation Part that originated this conversation, which + can be Contact, Admin, Campaign, Automated or Operator initiated. + properties: + type: + type: string + description: This includes conversation, email, facebook, instagram, phone_call, + phone_switch, push, sms, twitter and whatsapp. + example: conversation + id: + type: string + description: The id representing the message. + example: '3' + delivered_as: + type: string + description: The conversation's initiation type. Possible values are customer_initiated, + campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), + automated (Series and other outbounds with dynamic audience message) and + admin_initiated (fixed audience message, ticket initiated by an admin, + group email). + example: operator_initiated + subject: + type: string + description: Optional. The message subject. For Twitter, this will show + a generic message regarding why the subject is obscured. + example: '' + body: + type: string + description: The message body, which may contain HTML. For Twitter, this + will show a generic message regarding why the body is obscured. + example: "

Hey there!

" + author: + "$ref": "#/components/schemas/conversation_part_author" + attachments: + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + url: + type: string + nullable: true + description: The URL where the conversation was started. For Twitter, Email, + and Bots, this will be blank. + example: + redacted: + type: boolean + description: Whether or not the source message has been redacted. Only applicable + for contact initiated messages. + example: false + conversation_statistics: + title: Conversation statistics + type: object + nullable: true + description: A Statistics object containing all information required for reporting, + with timestamps and calculated metrics. + properties: + type: + type: string + description: '' + example: conversation_statistics + time_to_assignment: + type: integer + description: Duration until last assignment before first admin reply. In + seconds. + example: 2310 + time_to_admin_reply: + type: integer + description: Duration until first admin reply. Subtracts out of business + hours. In seconds. + example: 2310 + time_to_first_close: + type: integer + description: Duration until conversation was closed first time. Subtracts + out of business hours. In seconds. + example: 2310 + time_to_last_close: + type: integer + description: Duration until conversation was closed last time. Subtracts + out of business hours. In seconds. + example: 2310 + median_time_to_reply: + type: integer + description: Median based on all admin replies after a contact reply. Subtracts + out of business hours. In seconds. + example: 2310 + first_contact_reply_at: + type: integer + format: date-time + description: Time of first text conversation part from a contact. + example: 1663597233 + first_assignment_at: + type: integer + format: date-time + description: Time of first assignment after first_contact_reply_at. + example: 1663597233 + first_admin_reply_at: + type: integer + format: date-time + description: Time of first admin reply after first_contact_reply_at. + example: 1663597233 + first_close_at: + type: integer + format: date-time + description: Time of first close after first_contact_reply_at. + example: 1663597233 + last_assignment_at: + type: integer + format: date-time + description: Time of last assignment after first_contact_reply_at. + example: 1663597233 + last_assignment_admin_reply_at: + type: integer + format: date-time + description: Time of first admin reply since most recent assignment. + example: 1663597233 + last_contact_reply_at: + type: integer + format: date-time + description: Time of the last conversation part from a contact. + example: 1663597233 + last_admin_reply_at: + type: integer + format: date-time + description: Time of the last conversation part from an admin. + example: 1663597233 + last_close_at: + type: integer + format: date-time + description: Time of the last conversation close. + example: 1663597233 + last_closed_by_id: + type: string + description: The last admin who closed the conversation. Returns a reference + to an Admin object. + example: c3po + count_reopens: + type: integer + description: Number of reopens after first_contact_reply_at. + example: 1 + count_assignments: + type: integer + description: Number of assignments after first_contact_reply_at. + example: 1 + count_conversation_parts: + type: integer + description: Total number of conversation parts. + example: 1 + conversation_teammates: + title: Conversation teammates + type: object + nullable: true + description: The list of teammates who participated in the conversation (wrote + at least one conversation part). + properties: + type: + type: string + description: The type of the object - `admin.list`. + example: admin.list + teammates: + type: array + description: The list of teammates who participated in the conversation + (wrote at least one conversation part). + items: + "$ref": "#/components/schemas/reference" + convert_conversation_to_ticket_request: + description: You can convert a Conversation to a Ticket + type: object + title: Convert Ticket Request Payload + properties: + ticket_type_id: + type: string + description: The ID of the type of ticket you want to convert the conversation + to + example: '1234' + attributes: + "$ref": "#/components/schemas/ticket_request_custom_attributes" + required: + - ticket_type_id + convert_visitor_request: + description: You can merge a Visitor to a Contact of role type lead or user. + type: object + title: Convert Visitor Request Payload + properties: + type: + type: string + description: Represents the role of the Contact model. Accepts `lead` or + `user`. + example: user + user: + type: object + description: The unique identifiers retained after converting or merging. + properties: + id: + type: string + description: The unique identifier for the contact which is given by + Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + user_id: + type: string + description: A unique identifier for the contact which is given to Intercom, + which will be represented as external_id. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: The contact's email, retained by default if one is present. + example: winstonsmith@truth.org + anyOf: + - required: + - id + - required: + - user_id + visitor: + type: object + description: The unique identifiers to convert a single Visitor. + properties: + id: + type: string + description: The unique identifier for the contact which is given by + Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + user_id: + type: string + description: A unique identifier for the contact which is given to Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: The visitor's email. + example: winstonsmith@truth.org + anyOf: + - required: + - id + - required: + - user_id + - required: + - email + required: + - type + - user + - visitor + create_article_request: + description: You can create an Article + type: object + title: Create Article Request Payload + nullable: true + properties: + title: + type: string + description: The title of the article.For multilingual articles, this will + be the title of the default language's content. + example: Thanks for everything + description: + type: string + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Description of the Article + body: + type: string + description: The content of the article. For multilingual articles, this + will be the body of the default language's content. + example: "

This is the body in html

" + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: 1295 + state: + type: string + description: Whether the article will be `published` or will be a `draft`. + Defaults to draft. For multilingual articles, this will be the state of + the default language's content. + enum: + - published + - draft + example: draft + parent_id: + type: integer + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: 18 + parent_type: + type: string + description: The type of parent, which can either be a `collection` or `section`. + example: collection + translated_content: + "$ref": "#/components/schemas/article_translated_content" + required: + - title + - author_id + create_collection_request: + description: You can create a collection + type: object + title: Create Collection Request Payload + properties: + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: collection 51 + description: + type: string + description: The description of the collection. For multilingual collections, + this will be the description of the default language's content. + example: English description + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it will be + created as the first level collection. + example: '6871118' + help_center_id: + type: integer + nullable: true + description: The id of the help center where the collection will be created. + If `null` then it will be created in the default help center. + example: '123' + required: + - name + create_contact_request: + description: Payload to create a contact + type: object + title: Create Contact Request Payload + properties: + role: + type: string + description: The role of the contact. + external_id: + type: string + description: A unique identifier for the contact which is given to Intercom + email: + type: string + description: The contacts email + example: jdoe@example.com + phone: + type: string + nullable: true + description: The contacts phone + example: "+353871234567" + name: + type: string + nullable: true + description: The contacts name + example: John Doe + avatar: + type: string + nullable: true + description: An image URL containing the avatar of a contact + example: https://www.example.com/avatar_image.jpg + signed_up_at: + type: integer + format: date-time + nullable: true + description: The time specified for when a contact signed up + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: The time when the contact was last seen (either where the Intercom + Messenger was installed or when specified manually) + example: 1571672154 + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact + example: 123 + unsubscribed_from_emails: + type: boolean + nullable: true + description: Whether the contact is unsubscribed from emails + example: true + custom_attributes: + type: object + nullable: true + description: The custom attributes which are set for the contact + anyOf: + - required: + - email + title: Create contact with email + - required: + - external_id + title: Create contact with external_id + - required: + - role + title: Create contact with role + create_conversation_request: + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + type: object + title: Create Conversation Request Payload + properties: + from: + type: object + properties: + type: + type: string + enum: + - lead + - user + - contact + description: The role associated to the contact - user or lead. + example: user + id: + type: string + description: The identifier for the contact which is given by Intercom. + format: uuid + minLength: 24 + maxLength: 24 + example: 536e564f316c83104c000020 + required: + - type + - id + body: + type: string + description: The content of the message. HTML is not supported. + example: Hello + required: + - from + - body + create_data_attribute_request: + description: '' + type: object + title: Create Data Attribute Request + properties: + name: + type: string + description: The name of the data attribute. + example: My Data Attribute + model: + type: string + description: The model that the data attribute belongs to. + enum: + - contact + - company + example: contact + data_type: + type: string + description: The type of data stored for this attribute. + enum: + - string + - integer + - float + - boolean + - datetime + - date + example: string + description: + type: string + description: The readable description you see in the UI for the attribute. + example: My Data Attribute Description + options: + type: array + description: To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be `string`. + items: + type: string + example: + - option1 + - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + required: + - name + - model + - data_type + create_data_event_request: + description: '' + type: object + title: Create Data Event Request + properties: + event_name: + type: string + description: The name of the event that occurred. This is presented to your + App's admins when filtering and creating segments - a good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + created_at: + type: integer + format: date-time + description: The time the event occurred as a UTC Unix timestamp + example: 1671028894 + user_id: + type: string + description: Your identifier for the user. + example: '314159' + id: + type: string + description: The unique identifier for the contact (lead or user) which + is given by Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: An email address for your user. An email should only be used + where your application uses email to uniquely identify users. + example: frodo.baggins@example.com + metadata: + type: object + description: Optional metadata about the event. + additionalProperties: + type: string + example: + invite_code: ADDAFRIEND + anyOf: + - title: id required + required: + - event_name + - created_at + - id + - title: user_id required + required: + - event_name + - created_at + - user_id + - title: email required + required: + - event_name + - created_at + - email + create_data_event_summaries_request: + description: You can send a list of event summaries for a user. Each event summary + should contain the event name, the time the event occurred, and the number + of times the event occurred. The event name should be a past tense "verb-noun" + combination, to improve readability, for example `updated-plan`. + type: object + title: Create Data Event Summaries Request + properties: + user_id: + type: string + description: Your identifier for the user. + example: '314159' + event_summaries: + type: object + description: A list of event summaries for the user. Each event summary + should contain the event name, the time the event occurred, and the number + of times the event occurred. The event name should be a past tense 'verb-noun' + combination, to improve readability, for example `updated-plan`. + properties: + event_name: + type: string + description: The name of the event that occurred. A good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + count: + type: integer + description: The number of times the event occurred. + example: 1 + first: + type: integer + format: date-time + description: The first time the event was sent + example: 1671028894 + last: + type: integer + format: date-time + description: The last time the event was sent + example: 1671028894 + create_data_exports_request: + description: Request for creating a data export + type: object + title: Create Data Export Request + properties: + created_at_after: + type: integer + description: The start date that you request data for. It must be formatted + as a unix timestamp. + example: 1527811200 + created_at_before: + type: integer + description: The end date that you request data for. It must be formatted + as a unix timestamp. + example: 1527811200 + required: + - created_at_after + - created_at_before + create_message_request: + description: You can create a message + type: object + title: Create Message Request Payload + nullable: true + properties: + message_type: + type: string + description: 'The kind of message being created. Values: `in_app` or `email`.' + enum: + - in_app + - email + example: in_app + subject: + type: string + description: The title of the email. + example: Thanks for everything + body: + type: string + description: The content of the message. HTML and plaintext are supported. + example: Hello there + template: + type: string + description: The style of the outgoing message. Possible values `plain` + or `personal`. + example: plain + from: + type: object + description: The sender of the message. If not provided, the default sender + will be used. + properties: + type: + type: string + description: Always `admin`. + enum: + - admin + example: admin + id: + type: integer + description: The identifier for the admin which is given by Intercom. + example: 394051 + required: + - type + - id + to: + type: object + description: The sender of the message. If not provided, the default sender + will be used. + properties: + type: + type: string + description: The role associated to the contact - `user` or `lead`. + enum: + - user + - lead + example: user + id: + type: string + description: The identifier for the contact which is given by Intercom. + example: 536e564f316c83104c000020 + required: + - type + - id + created_at: + type: integer + description: The time the message was created. If not provided, the current + time will be used. + example: 1590000000 + create_conversation_without_contact_reply: + type: boolean + description: Whether a conversation should be opened in the inbox for the + message without the contact replying. Defaults to false if not provided. + default: false + example: true + anyOf: + - title: 'message_type: `email`.' + required: + - message_type + - subject + - body + - template + - from + - to + - title: 'message_type: `inapp`.' + required: + - message_type + - body + - from + - to + create_or_update_company_request: + type: object + title: Create Or Update Company Request Payload + description: You can create or update a Company + nullable: true + properties: + name: + type: string + description: The name of the Company + example: Intercom + company_id: + type: string + description: The company id you have defined for the company. Can't be updated + example: 625e90fc55ab113b6d92175f + plan: + type: string + description: The name of the plan you have associated with the company. + example: Enterprise + size: + type: integer + description: The number of employees in this company. + example: '100' + website: + type: string + description: The URL for this company's website. Please note that the value + specified here is not validated. Accepts any string. + example: https://www.example.com + industry: + type: string + description: The industry that this company operates in. + example: Manufacturing + custom_attributes: + type: object + description: A hash of key/value pairs containing any other data about the + company you want Intercom to store. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + remote_created_at: + type: integer + description: The time the company was created by you. + example: 1394531169 + monthly_spend: + type: integer + description: How much revenue the company generates for your business. Note + that this will truncate floats. i.e. it only allow for whole integers, + 155.98 will be truncated to 155. Note that this has an upper limit of + 2**31-1 or 2147483647.. + example: 1000 + create_or_update_tag_request: + description: You can create or update an existing tag. + type: object + title: Create or Update Tag Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found, or + the new name for the tag if this is an update request. Names are case + insensitive. + example: Independent + id: + type: string + description: The id of tag to updates. + example: '656452352' + required: + - name + create_phone_switch_request: + description: You can create an phone switch + type: object + title: Create Phone Switch Request Payload + nullable: true + properties: + phone: + type: string + description: Phone number in E.164 format, that will receive the SMS to + continue the conversation in the Messenger. + example: "+1 1234567890" + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + required: + - phone + create_ticket_reply_with_comment_request: + title: Create Ticket Reply Request Payload + oneOf: + - "$ref": "#/components/schemas/contact_reply_ticket_request" + - "$ref": "#/components/schemas/admin_reply_ticket_request" + create_ticket_request: + description: You can create a Ticket + type: object + title: Create Ticket Request Payload + properties: + ticket_type_id: + type: string + description: The ID of the type of ticket you want to create + example: '1234' + contacts: + type: array + description: The list of contacts (users or leads) affected by this ticket. + Currently only one is allowed + items: + type: object + oneOf: + - title: ID + properties: + id: + type: string + description: The identifier for the contact as given by Intercom. + required: + - id + - title: External ID + properties: + external_id: + type: string + description: The external_id you have defined for the contact who + is being added as a participant. + required: + - external_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being + added as a participant. If a contact with this email does not + exist, one will be created. + required: + - email + example: + - id: '1234' + company_id: + type: string + description: The ID of the company that the ticket is associated with. The + ID that you set upon company creation. + example: '1234' + created_at: + type: integer + description: The time the ticket was created. If not provided, the current + time will be used. + example: 1590000000 + ticket_attributes: + "$ref": "#/components/schemas/ticket_request_custom_attributes" + required: + - ticket_type_id + - contacts + create_ticket_type_attribute_request: + description: You can create a Ticket Type Attribute + type: object + title: Create Ticket Type Attribute Request Payload + properties: + name: + type: string + description: The name of the ticket type attribute + example: Bug Priority + description: + type: string + description: The description of the attribute presented to the teammate + or contact + example: Priority level of the bug + data_type: + type: string + description: The data type of the attribute + enum: + - string + - list + - integer + - decimal + - boolean + - datetime + - files + example: string + required_to_create: + type: boolean + description: Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible to teammates when creating + a ticket in Inbox. + default: true + example: true + visible_to_contacts: + type: boolean + description: Whether the attribute is visible to contacts when creating + a ticket in Messenger. + default: true + example: true + multiline: + type: boolean + description: Whether the attribute allows multiple lines of text (only applicable + to string attributes) + example: false + list_items: + type: string + description: A comma delimited list of items for the attribute value (only + applicable to list attributes) + example: Low Priority,Medium Priority,High Priority + allow_multiple_values: + type: boolean + description: Whether the attribute allows multiple files to be attached + to it (only applicable to file attributes) + example: false + required: + - name + - description + - data_type + create_ticket_type_request: + description: | + The request payload for creating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + type: object + title: Create Ticket Type Request Payload + nullable: true + properties: + name: + type: string + description: The name of the ticket type. + example: Bug + description: + type: string + description: The description of the ticket type. + example: Used for tracking bugs + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + icon: + type: string + description: The icon of the ticket type. + example: "\U0001F41E" + default: "\U0001F39F️" + is_internal: + type: boolean + description: Whether the tickets associated with this ticket type are intended + for internal use only or will be shared with customers. This is currently + a limited attribute. + example: false + default: false + required: + - name + cursor_pages: + title: Cursor based pages + type: object + description: | + Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. + A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed. + nullable: true + properties: + type: + type: string + description: the type of object `pages`. + example: pages + enum: + - pages + page: + type: integer + description: The current page + example: 1 + next: + "$ref": "#/components/schemas/starting_after_paging" + per_page: + type: integer + description: Number of results per page + example: 2 + total_pages: + type: integer + description: Total number of pages + example: 13 + custom_attributes: + title: Custom Attributes + type: object + description: An object containing the different custom attributes associated + to the conversation as key-value pairs. For relationship attributes the value + will be a list of custom object instance models. + additionalProperties: + anyOf: + - type: string + - "$ref": "#/components/schemas/custom_object_instance" + custom_object_instance: + title: Custom Object Instance + type: object + x-tags: + - Custom Object Instances + nullable: true + description: A Custom Object Instance represents an instance of a custom object + type. This allows you to create and set custom attributes to store data about + your customers that is not already captured by Intercom. The parent object + includes recommended default attributes and you can add your own custom attributes. + properties: + id: + type: string + description: The Intercom defined id representing the custom object instance. + example: 5a7a19e9f59ae20001d1c1e6 + external_id: + type: string + description: The id you have defined for the custom object instance. + example: 0001d1c1e65a7a19e9f59ae2 + type: + type: string + description: The identifier of the custom object type that defines the structure + of the custom object instance. + example: Order + custom_attributes: + type: object + description: The custom attributes you have set on the custom object instance. + additionalProperties: + type: string + customer_request: + type: object + nullable: true + oneOf: + - title: Intercom User ID + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + example: 6329bd9ffe4e2e91dac76188 + required: + - intercom_user_id + - title: User ID + properties: + user_id: + type: string + description: The external_id you have defined for the contact who is being + added as a participant. + example: 2e91dac761886329bd9ffe4e + required: + - user_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being added + as a participant. + example: sam.sung@example.com + required: + - email + data_attribute: + title: Data Attribute + type: object + x-tags: + - Data Attributes + description: Data Attributes are metadata used to describe your contact, company + and conversation models. These include standard and custom attributes. By + using the data attributes endpoint, you can get the global list of attributes + for your workspace, as well as create and archive custom attributes. + properties: + type: + type: string + description: Value is `data_attribute`. + enum: + - data_attribute + example: data_attribute + id: + type: integer + description: The unique identifier for the data attribute which is given + by Intercom. Only available for custom attributes. + example: 12878 + model: + type: string + description: Value is `contact` for user/lead attributes and `company` for + company attributes. + enum: + - contact + - company + example: contact + name: + type: string + description: Name of the attribute. + example: paid_subscriber + full_name: + type: string + description: Full name of the attribute. Should match the name unless it's + a nested attribute. We can split full_name on `.` to access nested user + object values. + example: custom_attributes.paid_subscriber + label: + type: string + description: Readable name of the attribute (i.e. name you see in the UI) + example: Paid Subscriber + description: + type: string + description: Readable description of the attribute. + example: Whether the user is a paid subscriber. + data_type: + type: string + description: The data type of the attribute. + enum: + - string + - integer + - float + - boolean + - date + example: boolean + options: + type: array + description: List of predefined options for attribute value. + items: + type: string + example: + - 'true' + - 'false' + api_writable: + type: boolean + description: Can this attribute be updated through API + example: true + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + ui_writable: + type: boolean + description: Can this attribute be updated in the UI + example: true + custom: + type: boolean + description: Set to true if this is a CDA + example: true + archived: + type: boolean + description: Is this attribute archived. (Only applicable to CDAs) + example: false + created_at: + type: integer + format: date-time + description: The time the attribute was created as a UTC Unix timestamp + example: 1671028894 + updated_at: + type: integer + format: date-time + description: The time the attribute was last updated as a UTC Unix timestamp + example: 1671028894 + admin_id: + type: string + description: Teammate who created the attribute. Only applicable to CDAs + example: '5712945' + data_attribute_list: + title: Data Attribute List + type: object + description: A list of all data attributes belonging to a workspace for contacts, + companies or conversations. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of data attributes + items: + "$ref": "#/components/schemas/data_attribute" + data_event: + title: Data Event + type: object + x-tags: + - Data Events + description: Data events are used to notify Intercom of changes to your data. + properties: + type: + type: string + description: The type of the object + enum: + - event + example: event + event_name: + type: string + description: The name of the event that occurred. This is presented to your + App's admins when filtering and creating segments - a good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + created_at: + type: integer + format: date-time + description: The time the event occurred as a UTC Unix timestamp + example: 1671028894 + user_id: + type: string + description: Your identifier for the user. + example: '314159' + id: + type: string + description: Your identifier for a lead or a user. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + intercom_user_id: + type: string + description: The Intercom identifier for the user. + example: 63a0979a5eeebeaf28dd56ba + email: + type: string + description: An email address for your user. An email should only be used + where your application uses email to uniquely identify users. + example: frodo.baggins@example.com + metadata: + type: object + description: Optional metadata about the event. + additionalProperties: + type: string + example: + invite_code: ADDAFRIEND + required: + - event_name + - created_at + data_event_list: + title: Data Event List + type: object + description: This will return a list of data events for the App. + properties: + type: + type: string + description: The type of the object + enum: + - event.list + example: event.list + events: + type: array + description: A list of data events + items: + "$ref": "#/components/schemas/data_event" + pages: + type: object + description: Pagination + properties: + next: + type: string + example: https://api.intercom.io/events?per_page=2&before=1389913941064&intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user" + since: + type: string + example: https://api.intercom.io/events?intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user&since=1389913941065 + data_event_summary: + title: Data Event Summary + type: object + description: This will return a summary of data events for the App. + properties: + type: + type: string + description: The type of the object + enum: + - event.summary + example: event.summary + email: + type: string + description: The email address of the user + example: Sam.Sung@example.com + intercom_user_id: + type: string + description: The Intercom user ID of the user + example: 63a0979a5eeebeaf28dd56ba + user_id: + type: string + description: The user ID of the user + example: 62b997f288e14803c5006932 + events: + type: array + description: A summary of data events + items: + "$ref": "#/components/schemas/data_event_summary_item" + data_event_summary_item: + title: Data Event Summary Item + type: object + description: This will return a summary of a data event for the App. + nullable: true + properties: + name: + type: string + description: The name of the event + example: placed-order + first: + type: string + description: The first time the event was sent + example: '2014-01-16T23:12:21.000+00:00' + last: + type: string + description: The last time the event was sent + example: '2014-01-16T23:12:21.000+00:00 ' + count: + type: integer + description: The number of times the event was sent + example: 1 + description: + type: string + description: The description of the event + example: A user placed an order + data_export: + title: Data Export + type: object + x-tags: + - Data Export + description: The data export api is used to view all message sent & viewed in + a given timeframe. + properties: + job_identfier: + type: string + description: The identifier for your job. + example: orzzsbd7hk67xyu + status: + type: string + enum: + - pending + - in_progress + - failed + - completed + - no_data + - canceled + description: The current state of your job. + example: pending + download_expires_at: + type: string + description: The time after which you will not be able to access the data. + example: '1674917488' + download_url: + type: string + description: The location where you can download your data. + example: https://api.intercom.test/download/messages/data/example + data_export_csv: + title: Data Export CSV + type: object + description: A CSV output file + properties: + user_id: + type: string + description: The user_id of the user who was sent the message. + user_external_id: + type: string + description: The external_user_id of the user who was sent the message + company_id: + type: string + description: The company ID of the user in relation to the message that + was sent. Will return -1 if no company is present. + email: + type: string + description: The users email who was sent the message. + name: + type: string + description: The full name of the user receiving the message + ruleset_id: + type: string + description: The id of the message. + content_id: + type: string + description: The specific content that was received. In an A/B test each + version has its own Content ID. + content_type: + type: string + description: Email, Chat, Post etc. + content_title: + type: string + description: The title of the content you see in your Intercom workspace. + ruleset_version_id: + type: string + description: As you edit content we record new versions. This ID can help + you determine which version of a piece of content that was received. + receipt_id: + type: string + description: ID for this receipt. Will be included with any related stats + in other files to identify this specific delivery of a message. + received_at: + type: integer + description: Timestamp for when the receipt was recorded. + series_id: + type: string + description: The id of the series that this content is part of. Will return + -1 if not part of a series. + series_title: + type: string + description: The title of the series that this content is part of. + node_id: + type: string + description: The id of the series node that this ruleset is associated with. + Each block in a series has a corresponding node_id. + first_reply: + type: integer + description: The first time a user replied to this message if the content + was able to receive replies. + first_completion: + type: integer + description: The first time a user completed this message if the content + was able to be completed e.g. Tours, Surveys. + first_series_completion: + type: integer + description: The first time the series this message was a part of was completed + by the user. + first_series_disengagement: + type: integer + description: The first time the series this message was a part of was disengaged + by the user. + first_series_exit: + type: integer + description: The first time the series this message was a part of was exited + by the user. + first_goal_success: + type: integer + description: The first time the user met this messages associated goal if + one exists. + first_open: + type: integer + description: The first time the user opened this message. + first_click: + type: integer + description: The first time the series the user clicked on a link within + this message. + first_dismisall: + type: integer + description: The first time the series the user dismissed this message. + first_unsubscribe: + type: integer + description: The first time the user unsubscribed from this message. + first_hard_bounce: + type: integer + description: The first time this message hard bounced for this user + deleted_article_object: + title: Deleted Article Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the article which you provided in + the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted. - article + enum: + - article + example: article + deleted: + type: boolean + description: Whether the article was deleted successfully or not. + example: true + deleted_collection_object: + title: Deleted Collection Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the collection which you provided + in the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted. - `collection` + enum: + - collection + example: collection + deleted: + type: boolean + description: Whether the collection was deleted successfully or not. + example: true + deleted_company_object: + title: Deleted Company Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the company which is given by Intercom. + example: 5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f + object: + type: string + description: The type of object which was deleted. - `company` + enum: + - company + example: company + deleted: + type: boolean + description: Whether the company was deleted successfully or not. + example: true + deleted_object: + title: Deleted Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the news item which you provided + in the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted - news-item. + enum: + - news-item + example: news-item + deleted: + type: boolean + description: Whether the news item was deleted successfully or not. + example: true + detach_contact_from_conversation_request: + properties: + admin_id: + type: string + description: The `id` of the admin who is performing the action. + example: '5017690' + required: + - admin_id + error: + type: object + title: Error + description: The API will return an Error List for a failed request, which will + contain one or more Error objects. + properties: + type: + type: string + description: The type is error.list + example: error.list + request_id: + type: string + nullable: true + format: uuid + description: '' + example: f93ecfa8-d08a-4325-8694-89aeb89c8f85 + errors: + type: array + description: An array of one or more error objects + items: + properties: + code: + type: string + description: A string indicating the kind of error, used to further + qualify the HTTP response code + example: unauthorized + message: + type: string + nullable: true + description: Optional. Human readable description of the error. + example: Access Token Invalid + field: + type: string + nullable: true + description: Optional. Used to identify a particular field or query + parameter that was in error. + example: email + required: + - code + required: + - type + - errors + file_attribute: + title: File + type: object + description: The value describing a file upload set for a custom attribute + properties: + type: + type: string + example: upload + name: + type: string + description: The name of the file + example: Screenshot.png + url: + type: string + description: The url of the file. This is a temporary URL and will expire + after 30 minutes. + example: https://intercom-attachments-1.com/.../Screenshot.png + content_type: + type: string + description: The type of file + example: image/png + filesize: + type: integer + description: The size of the file in bytes + example: 11308309 + width: + type: integer + description: The width of the file in pixels, if applicable + example: 3024 + height: + type: integer + description: The height of the file in pixels, if applicable + example: 1964 + group_content: + title: Group Content + type: object + description: The Content of a Group. + nullable: true + properties: + type: + type: string + description: The type of object - `group_content` . + enum: + - + - group_content + example: group_content + nullable: true + name: + type: string + description: The name of the collection or section. + example: Collection name + description: + type: string + description: The description of the collection. Only available for collections. + example: " Collection description" + group_translated_content: + title: Group Translated Content + type: object + description: The Translated Content of an Group. The keys are the locale codes + and the values are the translated content of the Group. + nullable: true + properties: + type: + type: string + description: The type of object - group_translated_content. + nullable: true + enum: + - + - group_translated_content + example: group_translated_content + ar: + description: The content of the group in Arabic + "$ref": "#/components/schemas/group_content" + bg: + description: The content of the group in Bulgarian + "$ref": "#/components/schemas/group_content" + bs: + description: The content of the group in Bosnian + "$ref": "#/components/schemas/group_content" + ca: + description: The content of the group in Catalan + "$ref": "#/components/schemas/group_content" + cs: + description: The content of the group in Czech + "$ref": "#/components/schemas/group_content" + da: + description: The content of the group in Danish + "$ref": "#/components/schemas/group_content" + de: + description: The content of the group in German + "$ref": "#/components/schemas/group_content" + el: + description: The content of the group in Greek + "$ref": "#/components/schemas/group_content" + en: + description: The content of the group in English + "$ref": "#/components/schemas/group_content" + es: + description: The content of the group in Spanish + "$ref": "#/components/schemas/group_content" + et: + description: The content of the group in Estonian + "$ref": "#/components/schemas/group_content" + fi: + description: The content of the group in Finnish + "$ref": "#/components/schemas/group_content" + fr: + description: The content of the group in French + "$ref": "#/components/schemas/group_content" + he: + description: The content of the group in Hebrew + "$ref": "#/components/schemas/group_content" + hr: + description: The content of the group in Croatian + "$ref": "#/components/schemas/group_content" + hu: + description: The content of the group in Hungarian + "$ref": "#/components/schemas/group_content" + id: + description: The content of the group in Indonesian + "$ref": "#/components/schemas/group_content" + it: + description: The content of the group in Italian + "$ref": "#/components/schemas/group_content" + ja: + description: The content of the group in Japanese + "$ref": "#/components/schemas/group_content" + ko: + description: The content of the group in Korean + "$ref": "#/components/schemas/group_content" + lt: + description: The content of the group in Lithuanian + "$ref": "#/components/schemas/group_content" + lv: + description: The content of the group in Latvian + "$ref": "#/components/schemas/group_content" + mn: + description: The content of the group in Mongolian + "$ref": "#/components/schemas/group_content" + nb: + description: The content of the group in Norwegian + "$ref": "#/components/schemas/group_content" + nl: + description: The content of the group in Dutch + "$ref": "#/components/schemas/group_content" + pl: + description: The content of the group in Polish + "$ref": "#/components/schemas/group_content" + pt: + description: The content of the group in Portuguese (Portugal) + "$ref": "#/components/schemas/group_content" + ro: + description: The content of the group in Romanian + "$ref": "#/components/schemas/group_content" + ru: + description: The content of the group in Russian + "$ref": "#/components/schemas/group_content" + sl: + description: The content of the group in Slovenian + "$ref": "#/components/schemas/group_content" + sr: + description: The content of the group in Serbian + "$ref": "#/components/schemas/group_content" + sv: + description: The content of the group in Swedish + "$ref": "#/components/schemas/group_content" + tr: + description: The content of the group in Turkish + "$ref": "#/components/schemas/group_content" + vi: + description: The content of the group in Vietnamese + "$ref": "#/components/schemas/group_content" + pt-BR: + description: The content of the group in Portuguese (Brazil) + "$ref": "#/components/schemas/group_content" + zh-CN: + description: The content of the group in Chinese (China) + "$ref": "#/components/schemas/group_content" + zh-TW: + description: The content of the group in Chinese (Taiwan) + "$ref": "#/components/schemas/group_content" + help_center: + title: Help Center + type: object + x-tags: + - Help Center + description: Help Centers contain collections + properties: + id: + type: string + description: The unique identifier for the Help Center which is given by + Intercom. + example: '123' + workspace_id: + type: string + description: The id of the workspace which the Help Center belongs to. + example: hfi1bx4l + created_at: + type: integer + format: date-time + description: The time when the Help Center was created. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the Help Center was last updated. + example: 1672928610 + identifier: + type: string + description: The identifier of the Help Center. This is used in the URL + of the Help Center. + example: intercom + website_turned_on: + type: boolean + description: Whether the Help Center is turned on or not. This is controlled + in your Help Center settings. + example: true + display_name: + type: string + description: The display name of the Help Center only seen by teammates. + example: Intercom Help Center + help_center_list: + title: Help Centers + type: object + x-tags: + - Help Center + description: A list of Help Centers belonging to the App + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + data: + type: array + description: An array of Help Center objects + items: + "$ref": "#/components/schemas/help_center" + intercom_version: + description: Intercom API version.
By default, it's equal to the version + set in the app package. + type: string + example: '2.11' + default: '2.11' + enum: + - '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 + linked_object: + title: Linked Object + type: object + description: A linked conversation or ticket. + properties: + type: + type: string + description: ticket or conversation + enum: + - ticket + - conversation + example: ticket + id: + type: string + description: The ID of the linked object + example: '7583' + category: + type: string + description: Category of the Linked Ticket Object. + enum: + - Customer + - Back-office + - Tracker + - + example: Customer + nullable: true + linked_object_list: + title: Linked Objects + type: object + description: An object containing metadata about linked conversations and linked + tickets. Up to 1000 can be returned. + properties: + type: + type: string + description: Always list. + enum: + - list + example: list + total_count: + type: integer + description: The total number of linked objects. + example: 100 + has_more: + type: boolean + description: Whether or not there are more linked objects than returned. + example: false + data: + type: array + description: An array containing the linked conversations and linked tickets. + items: + "$ref": "#/components/schemas/linked_object" + merge_contacts_request: + description: Merge contact data. + type: object + title: Merge contact data + properties: + from: + type: string + description: The unique identifier for the contact to merge away from. Must + be a lead. + example: 5d70dd30de4efd54f42fd526 + into: + type: string + description: The unique identifier for the contact to merge into. Must be + a user. + example: 5ba682d23d7cf92bef87bfd4 + message: + type: object + title: Message + x-tags: + - Messages + description: Message are how you reach out to contacts in Intercom. They are + created when an admin sends an outbound message to a contact. + properties: + type: + type: string + description: The type of the message + example: user_message + id: + type: string + description: The id representing the message. + example: '1488971108' + created_at: + type: integer + format: date-time + description: The time the conversation was created. + example: 1667560812 + subject: + type: string + description: 'The subject of the message. Only present if message_type: + email.' + example: Greetings + body: + type: string + description: The message body, which may contain HTML. + example: Hello + message_type: + type: string + enum: + - email + - inapp + - facebook + - twitter + description: The type of message that was sent. Can be email, inapp, facebook + or twitter. + example: inapp + conversation_id: + type: string + description: The associated conversation_id + example: '64619700005570' + required: + - type + - id + - created_at + - body + - message_type + multiple_filter_search_request: + title: Multiple Filter Search Request + description: Search using Intercoms Search APIs with more than one filter. + type: object + properties: + operator: + type: string + enum: + - AND + - OR + description: An operator to allow boolean inspection between multiple fields. + example: AND + value: + oneOf: + - type: array + description: Add mutiple filters. + title: multiple filter search request + items: + "$ref": "#/components/schemas/multiple_filter_search_request" + - type: array + description: Add a single filter field. + title: single filter search request + items: + "$ref": "#/components/schemas/single_filter_search_request" + news_item: + title: News Item + type: object + x-tags: + - News + description: A News Item is a content type in Intercom enabling you to announce + product updates, company news, promotions, events and more with your customers. + properties: + type: + type: string + description: The type of object. + enum: + - news-item + example: news-item + id: + type: string + description: The unique identifier for the news item which is given by Intercom. + example: '141' + workspace_id: + type: string + description: The id of the workspace which the news item belongs to. + example: t74hdn32 + title: + type: string + description: The title of the news item. + example: 'New feature: News Items' + body: + type: string + description: The news item body, which may contain HTML. + example: We are excited to announce the launch of News Items, a new content + type in Intercom enabling you to announce product updates, company news, + promotions, events and more with your customers. + sender_id: + type: integer + description: The id of the sender of the news item. Must be a teammate on + the workspace. + example: 123 + state: + type: string + description: News items will not be visible to your users in the assigned + newsfeeds until they are set live. + enum: + - draft + - live + example: live + newsfeed_assignments: + type: array + description: A list of newsfeed_assignments to assign to the specified newsfeed. + items: + "$ref": "#/components/schemas/newsfeed_assignment" + labels: + type: array + description: Label names displayed to users to categorize the news item. + items: + type: string + nullable: true + description: The label name. + example: Product Update + cover_image_url: + type: string + format: uri + nullable: true + description: URL of the image used as cover. Must have .jpg or .png extension. + example: https://example.com/cover.jpg + reactions: + type: array + description: Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + items: + type: string + nullable: true + description: The emoji reaction to the news item. + example: "\U0001F44D" + deliver_silently: + type: boolean + description: When set to true, the news item will appear in the messenger + newsfeed without showing a notification badge. + example: true + created_at: + type: integer + format: timestamp + description: Timestamp for when the news item was created. + example: 1610589632 + updated_at: + type: integer + format: timestamp + description: Timestamp for when the news item was last updated. + example: 1610589632 + news_item_request: + description: A News Item is a content type in Intercom enabling you to announce + product updates, company news, promotions, events and more with your customers. + type: object + title: Create News Item Request + properties: + title: + type: string + description: The title of the news item. + example: Halloween is here! + body: + type: string + description: The news item body, which may contain HTML. + example: "

New costumes in store for this spooky season

" + sender_id: + type: integer + description: The id of the sender of the news item. Must be a teammate on + the workspace. + example: 123 + state: + type: string + description: News items will not be visible to your users in the assigned + newsfeeds until they are set live. + enum: + - draft + - live + example: live + deliver_silently: + type: boolean + description: When set to `true`, the news item will appear in the messenger + newsfeed without showing a notification badge. + example: true + labels: + type: array + description: Label names displayed to users to categorize the news item. + items: + type: string + example: + - Product + - Update + - New + reactions: + type: array + description: Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + items: + type: string + nullable: true + example: + - "\U0001F606" + - "\U0001F605" + newsfeed_assignments: + type: array + description: A list of newsfeed_assignments to assign to the specified newsfeed. + items: + "$ref": "#/components/schemas/newsfeed_assignment" + required: + - title + - sender_id + newsfeed: + title: Newsfeed + type: object + x-tags: + - News + description: | + A newsfeed is a collection of news items, targeted to a specific audience. + + Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. + properties: + id: + type: string + description: The unique identifier for the newsfeed which is given by Intercom. + example: '12312' + type: + type: string + description: The type of object. + enum: + - newsfeed + example: newsfeed + name: + type: string + description: The name of the newsfeed. This name will never be visible to + your users. + example: My Newsfeed + created_at: + type: integer + format: timestamp + description: Timestamp for when the newsfeed was created. + example: 1674917488 + updated_at: + type: integer + format: timestamp + description: Timestamp for when the newsfeed was last updated. + example: 1674917488 + newsfeed_assignment: + title: Newsfeed Assignment + type: object + x-tags: + - News + description: Assigns a news item to a newsfeed. + properties: + newsfeed_id: + type: integer + description: The unique identifier for the newsfeed which is given by Intercom. + Publish dates cannot be in the future, to schedule news items use the + dedicated feature in app (see this article). + example: 198313 + published_at: + type: integer + format: timestamp + description: Publish date of the news item on the newsfeed, use this field + if you want to set a publish date in the past (e.g. when importing existing + news items). On write, this field will be ignored if the news item state + is "draft". + example: 1674917488 + note: + title: Note + type: object + x-tags: + - Notes + description: Notes allow you to annotate and comment on your contacts. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `note`. + example: note + id: + type: string + description: The id of the note. + example: '17495962' + created_at: + type: integer + format: timestamp + description: The time the note was created. + example: 1674589321 + contact: + type: object + description: Represents the contact that the note was created about. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `contact`. + id: + type: string + description: The id of the contact. + example: 214656d0c743eafcfde7f248 + author: + "$ref": "#/components/schemas/admin" + description: Optional. Represents the Admin that created the note. + body: + type: string + description: The body text of the note. + example: "

Text for the note.

" + note_list: + title: Paginated Response + type: object + description: A paginated list of notes associated with a contact. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `list`. + example: list + data: + type: array + description: An array of notes. + items: + "$ref": "#/components/schemas/note" + total_count: + type: integer + description: A count of the total number of notes. + example: 1 + pages: + "$ref": "#/components/schemas/cursor_pages" + open_conversation_request: + title: Open Conversation Request + type: object + description: Payload of the request to open a conversation + properties: + message_type: + type: string + enum: + - open + example: open + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '5017690' + required: + - message_type + - admin_id + pages_link: + title: Pagination Object + type: object + description: | + The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests. + + Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows. + properties: + type: + type: string + example: pages + enum: + - pages + page: + type: integer + example: 1 + next: + type: string + format: uri + description: A link to the next page of results. A response that does not + contain a next link does not have further data to fetch. + nullable: true + per_page: + type: integer + example: 50 + total_pages: + type: integer + example: 1 + paginated_response: + title: Paginated Response + type: object + description: Paginated Response + properties: + type: + type: string + description: The type of object + enum: + - list + - conversation.list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of objects. + example: 1 + data: + type: array + description: An array of Objects + items: + anyOf: + - "$ref": "#/components/schemas/news_item" + - "$ref": "#/components/schemas/newsfeed" + part_attachment: + title: Part attachment + type: object + description: The file attached to a part + properties: + type: + type: string + description: The type of attachment + example: upload + name: + type: string + description: The name of the attachment + example: example.png + url: + type: string + description: The URL of the attachment + example: https://picsum.photos/200/300 + content_type: + type: string + description: The content type of the attachment + example: image/png + filesize: + type: integer + description: The size of the attachment + example: 100 + width: + type: integer + description: The width of the attachment + example: 100 + height: + type: integer + description: The height of the attachment + example: 100 + phone_switch: + title: Phone Switch + type: object + description: Phone Switch Response + nullable: true + properties: + type: + type: string + description: '' + enum: + - phone_call_redirect + default: phone_call_redirect + example: phone_call_redirect + phone: + type: string + description: Phone number in E.164 format, that has received the SMS to + continue the conversation in the Messenger. + example: "+1 1234567890" + redact_conversation_request: + oneOf: + - title: Redact Conversation Part Request + type: object + description: Payload of the request to redact a conversation part + properties: + type: + type: string + enum: + - conversation_part + description: The type of resource being redacted. + example: conversation_part + conversation_id: + type: string + description: The id of the conversation. + example: '19894788788' + conversation_part_id: + type: string + description: The id of the conversation_part. + example: '19381789428' + required: + - type + - conversation_id + - conversation_part_id + - title: Redact Conversation Source Request + type: object + description: Payload of the request to redact a conversation source + properties: + type: + type: string + enum: + - source + description: The type of resource being redacted. + example: source + conversation_id: + type: string + description: The id of the conversation. + example: '19894788788' + source_id: + type: string + description: The id of the source. + example: '19894781231' + required: + - type + - conversation_id + - source_id + reference: + title: Reference + type: object + description: reference to another object + properties: + type: + type: string + description: '' + example: contact + id: + type: string + nullable: true + description: '' + example: 1a2b3c + reply_conversation_request: + oneOf: + - "$ref": "#/components/schemas/contact_reply_conversation_request" + - "$ref": "#/components/schemas/admin_reply_conversation_request" + search_request: + description: Search using Intercoms Search APIs. + type: object + title: Search data + properties: + query: + oneOf: + - "$ref": "#/components/schemas/single_filter_search_request" + title: Single filter search request + - "$ref": "#/components/schemas/multiple_filter_search_request" + title: multiple filter search request + pagination: + "$ref": "#/components/schemas/starting_after_paging" + required: + - query + segment: + title: Segment + type: object + x-tags: + - Segments + description: A segment is a group of your contacts defined by the rules that + you set. + properties: + type: + type: string + description: The type of object. + enum: + - segment + example: segment + id: + type: string + description: The unique identifier representing the segment. + example: 56203d253cba154d39010062 + name: + type: string + description: The name of the segment. + example: Active + created_at: + type: integer + description: The time the segment was created. + example: 1394621988 + updated_at: + type: integer + description: The time the segment was updated. + example: 1394622004 + person_type: + type: string + description: 'Type of the contact: contact (lead) or user.' + enum: + - contact + - user + example: contact + count: + type: integer + description: The number of items in the user segment. It's returned when + `include_count=true` is included in the request. + example: 3 + nullable: true + segment_list: + title: Segment List + type: object + description: This will return a list of Segment Objects. The result may also + have a pages object if the response is paginated. + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + example: segment.list + segments: + type: array + description: A list of Segment objects + items: + "$ref": "#/components/schemas/segment" + pages: + type: object + description: A pagination object, which may be empty, indicating no further + pages to fetch. + single_filter_search_request: + title: Single Filter Search Request + description: Search using Intercoms Search APIs with a single filter. + type: object + properties: + field: + type: string + description: The accepted field that you want to search on. + example: created_at + operator: + type: string + enum: + - "=" + - "!=" + - IN + - NIN + - "<" + - ">" + - "~" + - "!~" + - "^" + - "$" + description: The accepted operators you can use to define how you want to + search for the value. + example: ">" + value: + type: string + description: The value that you want to search on. + example: '73732934' + sla_applied: + title: Applied SLA + type: object + nullable: true + description: | + The SLA Applied object contains the details for which SLA has been applied to this conversation. + Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null. + properties: + type: + type: string + description: object type + example: conversation_sla_summary + sla_name: + type: string + description: The name of the SLA as given by the teammate when it was created. + example: '' + sla_status: + type: string + enum: + - hit + - missed + - cancelled + - active + description: |- + SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events. + example: hit + snooze_conversation_request: + title: Snooze Conversation Request + type: object + description: Payload of the request to snooze a conversation + properties: + message_type: + type: string + enum: + - snoozed + example: snoozed + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '5017691' + snoozed_until: + type: integer + format: timestamp + description: The time you want the conversation to reopen. + example: 1673609604 + required: + - message_type + - admin_id + - snoozed_until + social_profile: + title: Social Profile + type: object + description: A Social Profile allows you to label your contacts, companies, + and conversations and list them using that Social Profile. + properties: + type: + type: string + description: value is "social_profile" + example: social_profile + name: + type: string + description: The name of the Social media profile + example: Facebook + url: + type: string + format: uri + description: The name of the Social media profile + example: http://twitter.com/th1sland + starting_after_paging: + title: 'Pagination: Starting After' + type: object + nullable: true + properties: + per_page: + type: integer + description: The number of results to fetch per page. + example: 2 + starting_after: + type: string + description: The cursor to use in the next request to get the next page + of results. + nullable: true + example: your-cursor-from-response + subscription_type: + title: Subscription Types + type: object + x-tags: + - Subscription Types + description: A subscription type lets customers easily opt out of non-essential + communications without missing what's important to them. + properties: + type: + type: string + description: The type of the object - subscription + example: subscription + id: + type: string + description: The unique identifier representing the subscription type. + example: '123456' + state: + type: string + description: The state of the subscription type. + enum: + - live + - draft + - archived + example: live + default_translation: + "$ref": "#/components/schemas/translation" + translations: + type: array + description: An array of translations objects with the localised version + of the subscription type in each available locale within your translation + settings. + items: + "$ref": "#/components/schemas/translation" + consent_type: + type: string + description: Describes the type of consent. + enum: + - opt_out + - opt_in + example: opt_in + content_types: + type: array + description: The message types that this subscription supports - can contain + `email` or `sms_message`. + items: + type: string + enum: + - email + - sms_message + example: email + subscription_type_list: + title: Subscription Types + type: object + description: A list of subscription type objects. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of subscription type objects associated with the workspace + . + items: + "$ref": "#/components/schemas/subscription_type" + tag: + title: Tag + type: object + x-tags: + - Tags + description: A tag allows you to label your contacts, companies, and conversations + and list them using that tag. + properties: + type: + type: string + description: value is "tag" + example: tag + id: + type: string + description: The id of the tag + example: '123456' + name: + type: string + description: The name of the tag + example: Test tag + applied_at: + type: integer + format: date-time + description: The time when the tag was applied to the object + example: 1663597223 + applied_by: + "$ref": "#/components/schemas/reference" + tag_company_request: + description: You can tag a single company or a list of companies. + type: object + title: Tag Company Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found. + example: Independent + companies: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + description: The id or company_id of the company can be passed as input + parameters. + required: + - name + - companies + tag_list: + title: Tags + type: object + description: A list of tags objects in the workspace. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of tags objects associated with the workspace . + items: + "$ref": "#/components/schemas/tag" + tag_multiple_users_request: + description: You can tag a list of users. + type: object + title: Tag Users Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found. + example: Independent + users: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the user. + example: 5f7f0d217289f8d2f4262080 + required: + - name + - users + tags: + title: Tags + type: object + description: A list of tags objects associated with a conversation + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + example: tag.list + tags: + type: array + description: A list of tags objects associated with the conversation. + items: + "$ref": "#/components/schemas/tag" + team: + title: Team + type: object + x-tags: + - Teams + description: Teams are groups of admins in Intercom. + properties: + type: + type: string + description: Value is always "team" + example: team + id: + type: string + description: The id of the team + example: '814865' + name: + type: string + description: The name of the team + example: Example Team + admin_ids: + type: array + description: The list of admin IDs that are a part of the team. + example: + - 493881 + items: + type: integer + admin_priority_level: + "$ref": "#/components/schemas/admin_priority_level" + team_list: + title: Team List + type: object + description: This will return a list of team objects for the App. + properties: + type: + type: string + description: The type of the object + enum: + - team.list + example: team.list + teams: + type: array + description: A list of team objects + items: + "$ref": "#/components/schemas/team" + team_priority_level: + title: Team Priority Level + type: object + nullable: true + description: Admin priority levels for teams + properties: + primary_team_ids: + type: array + description: The primary team ids for the team + nullable: true + example: + - 814865 + items: + type: integer + secondary_team_ids: + type: array + description: The secondary team ids for the team + nullable: true + example: + - 493881 + items: + type: integer + ticket: + title: Ticket + type: object + x-tags: + - Tickets + description: Tickets are how you track requests from your users. + nullable: true + properties: + type: + type: string + description: Always ticket + enum: + - ticket + default: ticket + example: ticket + id: + type: string + description: The unique identifier for the ticket which is given by Intercom. + example: '1295' + ticket_id: + type: string + description: The ID of the Ticket used in the Intercom Inbox and Messenger. + Do not use ticket_id for API queries. + example: '1390' + category: + type: string + description: Category of the Ticket. + enum: + - Customer + - Back-office + - Tracker + example: Customer + ticket_attributes: + "$ref": "#/components/schemas/ticket_custom_attributes" + ticket_state: + type: string + description: The state the ticket is currently in + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + example: submitted + ticket_type: + "$ref": "#/components/schemas/ticket_type" + contacts: + "$ref": "#/components/schemas/ticket_contacts" + admin_assignee_id: + type: string + description: The id representing the admin assigned to the ticket. + example: '1295' + team_assignee_id: + type: string + description: The id representing the team assigned to the ticket. + example: '1295' + created_at: + type: integer + format: date-time + description: The time the ticket was created as a UTC Unix timestamp. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the ticket was updated as a UTC Unix timestamp. + example: 1663597260 + open: + type: boolean + description: Whether or not the ticket is open. If false, the ticket is + closed. + example: true + snoozed_until: + type: integer + format: date-time + description: The time the ticket will be snoozed until as a UTC Unix timestamp. + If null, the ticket is not currently snoozed. + example: 1663597260 + linked_objects: + "$ref": "#/components/schemas/linked_object_list" + ticket_parts: + "$ref": "#/components/schemas/ticket_parts" + is_shared: + type: boolean + description: Whether or not the ticket is shared with the customer. + example: true + ticket_state_internal_label: + type: string + description: The state the ticket is currently in, in a human readable form + - visible in Intercom + ticket_state_external_label: + type: string + description: The state the ticket is currently in, in a human readable form + - visible to customers, in the messenger, email and tickets portal. + ticket_contacts: + title: Contacts + type: object + x-tags: + - Tickets + description: The list of contacts affected by a ticket. + properties: + type: + type: string + description: always contact.list + enum: + - contact.list + example: contact.list + contacts: + type: array + description: The list of contacts affected by this ticket. + items: + "$ref": "#/components/schemas/contact_reference" + ticket_custom_attributes: + title: Ticket Attributes + type: object + description: An object containing the different attributes associated to the + ticket as key-value pairs. For the default title and description attributes, + the keys are `_default_title_` and `_default_description_`. + additionalProperties: + anyOf: + - type: string + nullable: true + - type: number + - type: boolean + - type: array + - "$ref": "#/components/schemas/file_attribute" + example: + _default_title_: Found a bug + _default_description_: The button's not working + ticket_list: + title: Ticket List + type: object + description: Tickets are how you track requests from your users. + properties: + type: + type: string + description: Always ticket.list + enum: + - ticket.list + example: ticket.list + tickets: + type: array + description: The list of ticket objects + items: + "$ref": "#/components/schemas/ticket" + total_count: + type: integer + description: A count of the total number of objects. + example: 12345 + pages: + "$ref": "#/components/schemas/cursor_pages" + ticket_part: + title: Ticket Part + type: object + x-tags: + - Tickets + description: A Ticket Part represents a message in the ticket. + properties: + type: + type: string + description: Always ticket_part + example: ticket_part + id: + type: string + description: The id representing the ticket part. + example: '3' + part_type: + type: string + description: The type of ticket part. + example: comment + body: + type: string + nullable: true + description: The message body, which may contain HTML. + example: "

Okay!

" + previous_ticket_state: + type: string + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + description: The previous state of the ticket. + example: submitted + ticket_state: + type: string + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + description: The state of the ticket. + example: submitted + created_at: + type: integer + format: date-time + description: The time the ticket part was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the ticket part was updated. + example: 1663597260 + assigned_to: + "$ref": "#/components/schemas/reference" + nullable: true + description: The id of the admin that was assigned the ticket by this ticket_part + (null if there has been no change in assignment.) + author: + "$ref": "#/components/schemas/ticket_part_author" + attachments: + title: Ticket part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + external_id: + type: string + nullable: true + description: The external id of the ticket part + example: abcd1234 + redacted: + type: boolean + description: Whether or not the ticket part has been redacted. + example: false + ticket_part_author: + title: Ticket part author + type: object + description: The author that wrote or triggered the part. Can be a bot, admin, + team or user. + properties: + type: + type: string + description: The type of the author + example: admin + enum: + - admin + - bot + - team + - user + id: + type: string + description: The id of the author + example: '274' + name: + type: string + nullable: true + description: The name of the author + example: Operator + email: + type: string + format: email + description: The email of the author + example: operator+abcd1234@intercom.io + ticket_parts: + title: Ticket Parts + type: object + description: A list of Ticket Part objects for each note and event in the ticket. + There is a limit of 500 parts. + properties: + type: + type: string + description: '' + enum: + - ticket_part.list + example: ticket_part.list + ticket_parts: + title: Tickt Parts + type: array + description: A list of Ticket Part objects for each ticket. There is a limit + of 500 parts. + items: + "$ref": "#/components/schemas/ticket_part" + total_count: + type: integer + description: '' + example: 2 + ticket_reply: + title: A Ticket Part representing a note, comment, or quick_reply on a ticket + type: object + description: A Ticket Part representing a note, comment, or quick_reply on a + ticket + properties: + type: + type: string + description: Always ticket_part + example: ticket_part + enum: + - ticket_part + id: + type: string + description: The id representing the part. + example: '3' + part_type: + type: string + description: Type of the part + example: note + enum: + - note + - comment + - quick_reply + body: + type: string + nullable: true + description: The message body, which may contain HTML. + example: "

Okay!

" + created_at: + type: integer + format: date-time + description: The time the note was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the note was updated. + example: 1663597260 + author: + "$ref": "#/components/schemas/ticket_part_author" + attachments: + title: Ticket part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + redacted: + type: boolean + description: Whether or not the ticket part has been redacted. + example: false + ticket_request_custom_attributes: + title: Ticket Attributes + type: object + description: The attributes set on the ticket. When setting the default title + and description attributes, the attribute keys that should be used are `_default_title_` + and `_default_description_`. When setting ticket type attributes of the list + attribute type, the key should be the attribute name and the value of the + attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). + For example, if the ticket type has an attribute called `priority` of type + `list`, the key should be `priority` and the value of the attribute should + be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`). + additionalProperties: + anyOf: + - type: string + nullable: true + - type: number + - type: boolean + - type: array + example: + _default_title_: Found a bug + _default_description_: The button is not working + ticket_type: + title: Ticket Type + type: object + x-tags: + - Tickets + description: A ticket type, used to define the data fields to be captured in + a ticket. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type`. + example: ticket_type + id: + type: string + description: The id representing the ticket type. + example: '1295' + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + name: + type: string + description: The name of the ticket type + example: Bug + description: + type: string + description: The description of the ticket type + example: A bug that has been reported. + icon: + type: string + description: The icon of the ticket type + example: "\U0001F41E" + workspace_id: + type: string + description: The id of the workspace that the ticket type belongs to. + example: ecahpwf5 + ticket_type_attributes: + "$ref": "#/components/schemas/ticket_type_attribute_list" + archived: + type: boolean + description: Whether the ticket type is archived or not. + example: false + created_at: + type: integer + format: timestamp + description: The date and time the ticket type was created. + updated_at: + type: integer + format: timestamp + description: The date and time the ticket type was last updated. + ticket_type_attribute: + title: Ticket Type Attribute + type: object + description: Ticket type attribute, used to define each data field to be captured + in a ticket. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type_attribute`. + example: ticket_type_attribute + id: + type: string + description: The id representing the ticket type attribute. + example: '1' + workspace_id: + type: string + description: The id of the workspace that the ticket type attribute belongs + to. + example: ecahpwf5 + name: + type: string + description: The name of the ticket type attribute + example: Title + description: + type: string + description: The description of the ticket type attribute + example: Bug title. + data_type: + type: string + description: 'The type of the data attribute (allowed values: "string list + integer decimal boolean datetime files")' + example: string + input_options: + type: object + description: Input options for the attribute + example: 'multiline: true' + order: + type: integer + description: The order of the attribute against other attributes + example: 1 + required_to_create: + type: boolean + description: Whether the attribute is required or not for teammates. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required or not for contacts. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible or not to teammates. + default: true + example: false + visible_to_contacts: + type: boolean + description: Whether the attribute is visible or not to contacts. + default: true + example: false + default: + type: boolean + description: Whether the attribute is built in or not. + example: true + ticket_type_id: + type: integer + description: The id of the ticket type that the attribute belongs to. + example: 42 + archived: + type: boolean + description: Whether the ticket type attribute is archived or not. + example: false + created_at: + type: integer + format: timestamp + description: The date and time the ticket type attribute was created. + updated_at: + type: integer + format: timestamp + description: The date and time the ticket type attribute was last updated. + ticket_type_attribute_list: + title: Ticket Type Attributes + type: object + description: A list of attributes associated with a given ticket type. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type_attributes.list`. + ticket_type_attributes: + type: array + description: A list of ticket type attributes associated with a given ticket + type. + items: + "$ref": "#/components/schemas/ticket_type_attribute" + ticket_type_list: + title: Ticket Types + type: object + description: A list of ticket types associated with a given workspace. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type.list`. + ticket_types: + type: array + description: A list of ticket_types associated with a given workspace. + items: + "$ref": "#/components/schemas/ticket_type" + translation: + title: Translation + type: object + description: A translation object contains the localised details of a subscription + type. + properties: + name: + type: string + description: The localised name of the subscription type. + example: Announcements + description: + type: string + description: The localised description of the subscription type. + example: Offers, product and feature announcements + locale: + type: string + description: The two character identifier for the language of the translation + object. + example: en + untag_company_request: + description: You can tag a single company or a list of companies. + type: object + title: Untag Company Request Payload + properties: + name: + type: string + description: The name of the tag which will be untagged from the company + example: Independent + companies: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + untag: + type: boolean + description: Always set to true + example: 'true' + description: The id or company_id of the company can be passed as input + parameters. + required: + - name + - companies + update_article_request: + description: You can Update an Article + type: object + title: Update Article Request Payload + nullable: true + properties: + title: + type: string + description: The title of the article.For multilingual articles, this will + be the title of the default language's content. + example: Thanks for everything + description: + type: string + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Description of the Article + body: + type: string + description: The content of the article. For multilingual articles, this + will be the body of the default language's content. + example: "

This is the body in html

" + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: 1295 + state: + type: string + description: Whether the article will be `published` or will be a `draft`. + Defaults to draft. For multilingual articles, this will be the state of + the default language's content. + enum: + - published + - draft + example: draft + parent_id: + type: string + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: '18' + parent_type: + type: string + description: The type of parent, which can either be a `collection` or `section`. + example: collection + translated_content: + "$ref": "#/components/schemas/article_translated_content" + update_collection_request: + description: You can update a collection + type: object + title: Update Collection Request Payload + properties: + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: collection 51 + description: + type: string + description: The description of the collection. For multilingual collections, + this will be the description of the default language's content. + example: English description + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it will be + updated as the first level collection. + example: '6871118' + update_contact_request: + description: You can update a contact + type: object + title: Update Contact Request Payload + properties: + role: + type: string + description: The role of the contact. + external_id: + type: string + description: A unique identifier for the contact which is given to Intercom + email: + type: string + description: The contacts email + example: jdoe@example.com + phone: + type: string + nullable: true + description: The contacts phone + example: "+353871234567" + name: + type: string + nullable: true + description: The contacts name + example: John Doe + avatar: + type: string + nullable: true + description: An image URL containing the avatar of a contact + example: https://www.example.com/avatar_image.jpg + signed_up_at: + type: integer + format: date-time + nullable: true + description: The time specified for when a contact signed up + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: The time when the contact was last seen (either where the Intercom + Messenger was installed or when specified manually) + example: 1571672154 + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact + example: 123 + unsubscribed_from_emails: + type: boolean + nullable: true + description: Whether the contact is unsubscribed from emails + example: true + custom_attributes: + type: object + nullable: true + description: The custom attributes which are set for the contact + update_conversation_request: + title: Update Conversation Request + type: object + description: Payload of the request to update a conversation + properties: + read: + type: boolean + description: Mark a conversation as read within Intercom. + example: true + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + update_data_attribute_request: + description: '' + type: object + title: Update Data Attribute Request + properties: + archived: + type: boolean + description: Whether the attribute is to be archived or not. + example: false + description: + type: string + description: The readable description you see in the UI for the attribute. + example: My Data Attribute Description + options: + type: array + description: To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be `string`. + items: + type: string + example: + - option1 + - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + update_ticket_request: + description: You can update a Ticket + type: object + title: Update Ticket Request Payload + properties: + ticket_attributes: + type: object + description: The attributes set on the ticket. + example: + _default_title_: example + _default_description_: having a problem + state: + type: string + enum: + - in_progress + - waiting_on_customer + - resolved + description: The state of the ticket. + example: submitted + open: + type: boolean + description: Specify if a ticket is open. Set to false to close a ticket. + Closing a ticket will also unsnooze it. + example: true + is_shared: + type: boolean + description: Specify whether the ticket is visible to users. + example: true + snoozed_until: + type: integer + format: timestamp + description: The time you want the ticket to reopen. + example: 1673609604 + assignment: + type: object + properties: + admin_id: + type: string + description: The ID of the admin performing the action. + example: '123' + assignee_id: + type: string + description: The ID of the admin or team to which the ticket is assigned. + Set this 0 to unassign it. + example: '123' + update_ticket_type_attribute_request: + description: You can update a Ticket Type Attribute + type: object + title: Update Ticket Type Attribute Request Payload + properties: + name: + type: string + description: The name of the ticket type attribute + example: Bug Priority + description: + type: string + description: The description of the attribute presented to the teammate + or contact + example: Priority level of the bug + required_to_create: + type: boolean + description: Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible to teammates when creating + a ticket in Inbox. + default: true + example: true + visible_to_contacts: + type: boolean + description: Whether the attribute is visible to contacts when creating + a ticket in Messenger. + default: true + example: true + multiline: + type: boolean + description: Whether the attribute allows multiple lines of text (only applicable + to string attributes) + example: false + list_items: + type: string + description: A comma delimited list of items for the attribute value (only + applicable to list attributes) + example: Low Priority,Medium Priority,High Priority + allow_multiple_values: + type: boolean + description: Whether the attribute allows multiple files to be attached + to it (only applicable to file attributes) + example: false + archived: + type: boolean + description: Whether the attribute should be archived and not shown during + creation of the ticket (it will still be present on previously created + tickets) + example: false + update_ticket_type_request: + description: | + The request payload for updating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + type: object + title: Update Ticket Type Request Payload + nullable: true + properties: + name: + type: string + description: The name of the ticket type. + example: Bug + description: + type: string + description: The description of the ticket type. + example: A bug has been occured + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + icon: + type: string + description: The icon of the ticket type. + example: "\U0001F41E" + default: "\U0001F39F️" + archived: + type: boolean + description: The archived status of the ticket type. + example: false + is_internal: + type: boolean + description: Whether the tickets associated with this ticket type are intended + for internal use only or will be shared with customers. This is currently + a limited attribute. + example: false + default: false + update_visitor_request: + description: Update an existing visitor. + type: object + title: Update Visitor Request Payload + properties: + id: + type: string + description: A unique identified for the visitor which is given by Intercom. + example: 8a88a590-e + user_id: + type: string + description: A unique identified for the visitor which is given by you. + example: '123' + name: + type: string + description: The visitor's name. + example: Christian Bale + custom_attributes: + type: object + description: The custom attributes which are set for the visitor. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + anyOf: + - required: + - id + - required: + - user_id + visitor: + title: Visitor + type: object + description: Visitors are useful for representing anonymous people that have + not yet been identified. They usually represent website visitors. Visitors + are not visible in Intercom platform. The Visitors resource provides methods + to fetch, update, convert and delete. + nullable: true + properties: + type: + type: string + description: Value is 'visitor' + default: visitor + example: visitor + id: + type: string + description: The Intercom defined id representing the Visitor. + example: 530370b477ad7120001d + user_id: + type: string + description: Automatically generated identifier for the Visitor. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + anonymous: + type: boolean + description: Identifies if this visitor is anonymous. + example: false + email: + type: string + format: email + description: The email of the visitor. + example: jane.doe@example.com + phone: + type: string + nullable: true + description: The phone number of the visitor. + example: 555-555-5555 + name: + type: string + nullable: true + description: The name of the visitor. + example: Jane Doe + pseudonym: + type: string + nullable: true + description: The pseudonym of the visitor. + example: Red Duck from Dublin + avatar: + type: object + properties: + type: + type: string + description: '' + default: avatar + example: avatar + image_url: + type: string + format: uri + nullable: true + description: This object represents the avatar associated with the visitor. + example: https://example.com/avatar.png + app_id: + type: string + description: The id of the app the visitor is associated with. + example: hfi1bx4l + companies: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - company.list + example: company.list + companies: + type: array + items: + "$ref": "#/components/schemas/company" + location_data: + type: object + properties: + type: + type: string + description: '' + default: location_data + example: location_data + city_name: + type: string + description: The city name of the visitor. + example: Dublin + continent_code: + type: string + description: The continent code of the visitor. + example: EU + country_code: + type: string + description: The country code of the visitor. + example: IRL + country_name: + type: string + description: The country name of the visitor. + example: Ireland + postal_code: + type: string + description: The postal code of the visitor. + example: D02 N960 + region_name: + type: string + description: The region name of the visitor. + example: Leinster + timezone: + type: string + description: The timezone of the visitor. + example: Europe/Dublin + las_request_at: + type: integer + description: The time the Lead last recorded making a request. + example: 1663597260 + created_at: + type: integer + description: The time the Visitor was added to Intercom. + example: 1663597223 + remote_created_at: + type: integer + description: The time the Visitor was added to Intercom. + example: 1663597223 + signed_up_at: + type: integer + description: The time the Visitor signed up for your product. + example: 1663597223 + updated_at: + type: integer + description: The last time the Visitor was updated. + example: 1663597260 + session_count: + type: integer + description: The number of sessions the Visitor has had. + example: 1 + social_profiles: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - social_profile.list + example: social_profile.list + social_profiles: + type: array + items: + type: string + owner_id: + type: string + nullable: true + description: The id of the admin that owns the Visitor. + example: '5169261' + unsubscribed_from_emails: + type: boolean + description: Whether the Visitor is unsubscribed from emails. + example: false + marked_email_as_spam: + type: boolean + description: Identifies if this visitor has marked an email as spam. + example: false + has_hard_bounced: + type: boolean + description: Identifies if this visitor has had a hard bounce. + example: false + tags: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + example: tag.list + tags: + type: array + items: + properties: + type: + type: string + description: The type of the object + enum: + - tag + example: tag + id: + type: string + description: The id of the tag. + example: '8482' + name: + type: string + description: The name of the tag. + example: tag_name + segments: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + example: segment.list + segments: + type: array + items: + type: string + custom_attributes: + type: object + description: The custom attributes you have set on the Visitor. + additionalProperties: + type: string + referrer: + type: string + nullable: true + description: The referer of the visitor. + example: https://www.google.com/ + utm_campaign: + type: string + nullable: true + description: The utm_campaign of the visitor. + example: intercom-link + utm_content: + type: string + nullable: true + description: The utm_content of the visitor. + example: banner + utm_medium: + type: string + nullable: true + description: The utm_medium of the visitor. + example: email + utm_source: + type: string + nullable: true + description: The utm_source of the visitor. + example: Intercom + utm_term: + type: string + nullable: true + description: The utm_term of the visitor. + example: messenger + do_not_track: + type: boolean + nullable: true + description: Identifies if this visitor has do not track enabled. + example: false + visitor_deleted_object: + title: Visitor Deleted Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the visitor which is given by Intercom. + example: 530370b477ad7120001d + type: + type: string + description: The type of object which was deleted + enum: + - visitor + example: visitor + user_id: + type: string + description: Automatically generated identifier for the Visitor. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + securitySchemes: + bearerAuth: + type: http + scheme: bearer +servers: +- url: https://api.intercom.io + description: The production API server +- url: https://api.eu.intercom.io + description: The european API server +- url: https://api.au.intercom.io + description: The australian API server +security: +- bearerAuth: [] +tags: +- name: Admins + description: Everything about your Admins +- name: Articles + description: Everything about your Articles +- name: Companies + description: Everything about your Companies +- name: Contacts + description: Everything about your contacts +- name: Conversations + description: Everything about your Conversations + externalDocs: + description: What is a conversation? + url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation +- name: Data Attributes + description: Everything about your Data Attributes +- name: Data Events + description: Everything about your Data Events +- name: Data Export + description: Everything about your Data Exports +- name: Help Center + description: Everything about your Help Center +- name: Messages + description: Everything about your messages +- name: News + description: Everything about your News + externalDocs: + description: News explained + url: https://www.intercom.com/help/en/articles/6362251-news-explained +- name: Notes + description: Everything about your Notes +- name: Segments + description: Everything about your Segments +- name: Subscription Types + description: Everything about subscription types +- name: Switch + description: Everything about Switch + externalDocs: + description: 'Meet Switch: from on hold to messaging in just a few taps' + url: https://www.intercom.com/switch +- name: Tags + description: Everything about tags +- name: Teams + description: Everything about your Teams +- name: Ticket Type Attributes + description: Everything about your ticket type attributes +- name: Ticket Types + description: Everything about your ticket types +- name: Tickets + description: Everything about your tickets +- name: Visitors + description: Everything about your Visitors \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/query-params/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/query-params/openapi.yml new file mode 100644 index 0000000000..ab7d7b817b --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/query-params/openapi.yml @@ -0,0 +1,65 @@ +openapi: 3.0.0 +info: + title: Query Parameters API + version: 1.0.0 +paths: + /search: + get: + operationId: search + parameters: + - name: filter + in: query + required: false + schema: + type: object + properties: + name: + type: string + age: + type: integer + location: + type: object + properties: + city: + type: string + country: + type: string + coordinates: + type: object + properties: + latitude: + type: number + longitude: + type: number + - name: sort + in: query + required: false + schema: + type: string + enum: [asc, desc] + - name: limit + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + - name: tags + in: query + required: false + schema: + type: array + items: + type: string + responses: + 200: + description: Successful response + content: + application/json: + schema: + type: object + properties: + results: + type: array + items: + type: string diff --git a/packages/parsers/src/openapi/__test__/fixtures/readonly/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/readonly/openapi.yml new file mode 100644 index 0000000000..b85ef79305 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/readonly/openapi.yml @@ -0,0 +1,97 @@ +openapi: 3.1.0 +info: + title: Readonly Properties API + version: 1.0.0 + +paths: + /users: + post: + summary: Create a user + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserCreate' + responses: + '200': + description: User created successfully + content: + application/json: + schema: + $ref: '#/components/schemas/User' + + /users/{userId}: + get: + summary: Get a user + parameters: + - name: userId + in: path + required: true + schema: + type: string + responses: + '200': + description: User retrieved successfully + content: + application/json: + schema: + $ref: '#/components/schemas/User' + +components: + schemas: + UserCreate: + type: object + properties: + name: + type: string + email: + type: string + settings: + $ref: '#/components/schemas/UserSettings' + + User: + type: object + properties: + id: + type: string + readOnly: true + name: + type: string + email: + type: string + createdAt: + type: string + format: date-time + readOnly: true + settings: + $ref: '#/components/schemas/UserSettings' + stats: + $ref: '#/components/schemas/UserStats' + + UserSettings: + type: object + properties: + theme: + type: string + notifications: + type: boolean + lastModified: + type: string + format: date-time + readOnly: true + + UserStats: + type: object + properties: + totalLogins: + type: integer + readOnly: true + lastLoginTime: + type: string + format: date-time + readOnly: true + accountStatus: + type: string + enum: [active, suspended, deleted] + diff --git a/packages/parsers/src/openapi/__test__/fixtures/request-response-description/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/request-response-description/openapi.yml new file mode 100644 index 0000000000..a48bac46cf --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/request-response-description/openapi.yml @@ -0,0 +1,26 @@ +openapi: 3.0.0 +info: + title: Sample API + version: 1.0.0 +paths: + /example: + get: + summary: Get Example + responses: + '200': + description: Successful response + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/Schema1" +components: + schemas: + Schema1: + type: object + description: Schema 1 description + properties: + id: + type: integer + name: + type: string \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/request-response-description/versions.yml b/packages/parsers/src/openapi/__test__/fixtures/request-response-description/versions.yml new file mode 100644 index 0000000000..321efbcb77 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/request-response-description/versions.yml @@ -0,0 +1,8128 @@ +- changelogEntry: + - summary: | + Now, the fern definition supports descriptions supplied on request and response bodies. + You can enable this by simply supplying `docs` in your fern definition, or `description` + in your OpenAPI spec. + type: feat + irVersion: 53 + version: 0.44.7 + +- changelogEntry: + - summary: | + The Fern Definition respects endpoint level base-path overrides when validating examples. + type: fix + irVersion: 53 + version: 0.44.6 + +- changelogEntry: + - summary: | + The Fern Definition now supports overriding `base-path` at the endpoint level. + This is useful if you have subset of endpoints that do not live at the + configured base-path. + + ```yml imdb.yml + service: + endpoints: + getMovie: + method: POST + base-path: "latest/" # overrides the base-path configured in api.yml + path: "movies/{movieId}" + ``` + type: feat + irVersion: 53 + version: 0.44.5 + +- changelogEntry: + - summary: | + Fern's OpenAPI importer will now handle generating examples for declared + errors so that they show up in the generated documentation. + type: fix + irVersion: 53 + version: 0.44.4 + +- changelogEntry: + - summary: | + Fern's OpenAPI importer can now handle `readOnly` properties in the top level + request schema. Note that Fern does not handle nested `readOnly` properties + just yet; please file a GitHub issue if this is important! + type: feat + irVersion: 53 + version: 0.44.3 + +- changelogEntry: + - summary: | + Fern's OpenAPI importer can now handle multiple error schemas for the + same status code. + type: fix + irVersion: 53 + version: 0.44.2 + +- changelogEntry: + - summary: | + The OpenAPI importer used to try and coerce all enums into a literals. + In some cases this is not desirable, so we now expose an option called + `coerce-enums-to-literals` in your generators.yml. + + ```yml generators.yml + api: + specs: + - openapi: ../openapi.json + overrides: ../openapi-overrides.yml + settings: + title-as-schema-name: false + coerce-enums-to-literals: false + ``` + type: feat + irVersion: 53 + version: 0.44.1 + +- changelogEntry: + - summary: | + The Fern CLI now supports parsing [Conjure](https://github.com/palantir/conjure), Palantir's + home-grown API Definition format. + + If you know a company that is using Conjure that wants API Docs + SDKs, send them our way! + type: feat + irVersion: 53 + version: 0.44.0-rc0 + +- changelogEntry: + - summary: | + Any markdown files that have custom components are also pushed up to the Fern Docs + platform. + type: fix + irVersion: 53 + version: 0.43.8 + +- changelogEntry: + - summary: | + The `valid-markdown` rule has been updated to try and parse the markdown file into a + valid AST. If the file fails to parse, `fern check` will log an error as well + as the path to the markdown. + type: fix + irVersion: 53 + version: 0.43.7 + +- changelogEntry: + - summary: | + The OpenAPI importer now appropriately brings in responses that are under the `text/event-stream` + Content-Type if your endpoint is annotated with `x-fern-streaming`. + If your endpoint is not annotated with `x-fern-streaming`, then the response will be ignored. + type: fix + irVersion: 53 + version: 0.43.6 + +- changelogEntry: + - summary: | + If you use the `x-fern-streaming` extension and want to provide different descriptions + for the streaming endpoint, then you can now specify `streaming-description`. + + ```yml openapi.yml + x-fern-streaming: + stream-condition: $request.stream + stream-description: The streaming version of this endpoint returns a series of chunks ... + response: + $ref: #/components/schemas/Response + stream-response: + $ref: #/components/schemas/ResponseChunk + ``` + type: fix + irVersion: 53 + version: 0.43.5 + +- changelogEntry: + - summary: | + The OpenAPI parser now respects the content type in your OpenAPI spec, instead of always sending + `application/json`. With this upgrade, your SDKs will also start to send the correct content type. + type: fix + irVersion: 53 + version: 0.43.4 + +- changelogEntry: + - summary: | + The CLI now passes in the API definition ID once again, this is necessary so that generated snippet templates + may reference schemas within the API. This was a regression that was recently introduced. + type: chore + irVersion: 53 + version: 0.43.3 + +- changelogEntry: + - summary: | + The CLI now prints which API cannot be registered if `fern generate --docs` fails. + type: fix + irVersion: 53 + version: 0.43.2 + +- changelogEntry: + - summary: | + The CLI now supports running OpenAPI generator 0.1.0 with IR version 53. + type: feat + irVersion: 53 + version: 0.43.1 + +- changelogEntry: + - summary: | + The CLI now recognizes the fern-php-sdk generator. + type: feat + irVersion: 53 + version: 0.43.0 + +- changelogEntry: + - summary: | + The documentation resolver now approrpiately creates a unique identifier for changelog sections. Previously, if you had multiple + changelogs within the same section, despite their title and slug being different, they would be treated as the same section since the ID + only took into account the parents' slug, appended the word "changelog" and that was all. + + As a result previously all changelogs within the same section would get highlighted when one was selected, now only the selected changelog + is highlighted. + type: internal + irVersion: 53 + version: 0.42.15 + +- changelogEntry: + - summary: | + The OpenAPI importer now correctly propagates the title field on `oneof` schemas. + type: fix + irVersion: 53 + version: 0.42.14 + +- changelogEntry: + - summary: | + Example generation now intelligently truncates container examples, for example if the depth limit will be reached on a list of objects, + the list will be returned as an empty list, as opposed the previous behavior where an unknown object would be created. + type: fix + irVersion: 53 + version: 0.42.13 + +- changelogEntry: + - summary: | + Previously, deploying docs from Windows machines led to bad asset paths. + Now, the CLI respects Windows paths during run and web paths for retrieving + assets. + type: fix + irVersion: 53 + version: 0.42.12 + +- changelogEntry: + - summary: | + The API V2 configuration now supports disabling using titles as schema + names. You may want to disable this flag if your OpenAPI adds the same + title to multiple schemas. + + ``` + api: + specs: + - openapi: /path/to/openapi + settings: + use-title-as-schema-name: false + ``` + type: fix + irVersion: 53 + version: 0.42.11 + +- changelogEntry: + - summary: | + Previously, the OpenAPI converter would bring over `title` on every + single property. This field is extraneous, so now we ignore it. + type: fix + irVersion: 53 + version: 0.42.10 + +- changelogEntry: + - summary: | + Previously, the OpenAPI importer would ignore skip parsing arbitrary + content types "*/*". Now it treats this content type as application/json. + + ```json openapi.json + "responses": { + "200": { + "description": "Success reply", + "content": { + "*/*": { + ``` + type: fix + irVersion: 53 + version: 0.42.9 + +- changelogEntry: + - summary: | + The API V2 configuration (in beta) now supports global header overrides. + This fixes a bug where those header overrides were getting dropped in + certain cases. + + ```yml generators.yml + api: + headers: + X-API-VERSION: string + specs: + - openapi: /path/to/openapi + overrides: /path/to/overrides + ``` + type: fix + irVersion: 53 + version: 0.42.8 + +- changelogEntry: + - summary: | + The API V2 configuration (in beta) now supports global header + overrides. To specify global headers that are not in your + OpenAPI spec, simply add the following block in your `generators.yml`: + + ```yml generators.yml + api: + headers: + X-API-VERSION: string + specs: + - openapi: /path/to/openapi + overrides: /path/to/overrides + ``` + type: feat + irVersion: 53 + version: 0.42.7 + +- changelogEntry: + - summary: Removes extraneous conditional error within namespacing configuration + type: fix + irVersion: 53 + version: 0.42.6 + +- changelogEntry: + - summary: Adds additional metadata retrievable by `fern generator get` so you can now get the langauage and the target repo. + type: feat + irVersion: 53 + version: 0.42.5 + +- changelogEntry: + - summary: | + Namespaced APIs now: + - No longer contain duplicative nesting of some endpoint within another package of the same name as the namespace + - Respect the `x-fern-sdk-group-name` annotation for endpoints + type: fix + irVersion: 53 + version: 0.42.4 + +- changelogEntry: + - summary: | + The OpenAPI importer now supports handling encoding on multipart requests. + Previously, the generators would not respect the `contentType` field for + each form input. But, now they do. + ```yml + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + description: The file to upload + encoding: + file: + contentType: "application/octet-stream" + ``` + type: fix + - summary: | + The OpenAPI importer now correctly parses descriptions of multipart + form requests. Previously these descriptions would be ignored. + + For example, previously the description `The file to upload` would be + ignored in the example below. + ```yml + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + description: The file to upload + ``` + type: fix + + irVersion: 53 + version: 0.42.3 + +- changelogEntry: + - summary: Error bodies are now appropriately namespaced as well! + type: fix + irVersion: 53 + version: 0.42.2 + +- changelogEntry: + - summary: | + Make sure to check for optionality when parsing stdout and stderr in CLI. This + removes the error: `Cannot read properties of undefined (reading 'includes')`. + type: fix + irVersion: 53 + version: 0.42.1 + +- changelogEntry: + - summary: | + If you merge multiple OpenAPI specs with namespaces, `fern check` will no longer + complain about duplicate schema names across namespaces. + In the example below, both OpenAPI specs can have duplicative schema names and + that is okay. + ```yml + api: + specs: + - openapi: openapi-bar.yml + namespace: bar + - openapi: opneapi-foo.yml + namespace: foo + ``` + type: fix + irVersion: 53 + version: 0.42.0 + +- changelogEntry: + - summary: | + Previously the OpenAPI converter would incorrectly mark + the values of `additionalProperties` as optional. Now, we have + introduced a feature flag to turn this behavior off. + + The feature flag can be configured in generators.yml: + ```yml + api: + specs: + - openapi: /path/to/openapi + settings: + optional-additional-properties: false + ``` + type: fix + irVersion: 53 + version: 0.41.16 + +- changelogEntry: + - summary: | + Performance improvements for stringifiying large Intermediate Representations. If + you have a large OpenAPI spec or Fern Definition, this can potentially shave off + minutes from `fern generate`. + type: internal + irVersion: 53 + version: 0.41.15 + +- changelogEntry: + - summary: | + The Fern Definition now supports `conten-type` on multipart request properties. + For example, to specify an `application/octet-stream` and `application/json` + contnet types, use the snippet below: + + ```ts + service: + endpoints: + upload: + request: + body: + properties: + file: + type: file + content-type: application/octet-stream + metadata: + type: unknown + content-type: application/json + ``` + type: feat + irVersion: 53 + version: 0.42.0-rc0 + +- changelogEntry: + - summary: Remove bang operator and fix eslint warning in `compatible-ir-versions.ts`. + type: internal + irVersion: 53 + version: 0.41.14-rc2 + +- changelogEntry: + - summary: | + Running `fern check` will now check to confirm that the generator versions you are running are compatible with your Fern CLI version. + + Each version of SDK generators depends on a version of a libary that is exported by the Fern CLI, and as a result, each generator has a minimum + compatible version of the Fern CLI. As an example, if you were to run `fern check` while leveraging `fernapi/fern-python-sdk` version `2.0.0`, on CLI version `0.1.3`, you'd receive the following error: + + `The generator fernapi/fern-python-sdk requires CLI version 0.23.0-rc4 or later (current version: 0.1.3-rc0).` + + Indicating that you must upgrade your CLI in order to leverage the current generator. + added: + - Running `fern check` will now check to confirm that the generator versions you are running are compatible with your Fern CLI version. + - Fern commands now print out generator upgrades, in addition to CLI upgrades. + type: feat + irVersion: 53 + version: 0.41.14-rc1 + +- changelogEntry: + - summary: | + The Fern CLI now safely handles a npx file exists error by retrying the command on failure. + This error typically happens when two or more instances of the Fern CLI are running `npx` + at the same time. + type: fix + irVersion: 53 + version: 0.41.14-rc0 + +- changelogEntry: + - summary: | + `fern generate --local` no longer crashes on large API Definitions because we + stream the JSON to file instead of calling `JSON.stringify`. See [PR 4640](https://github.com/fern-api/fern/pull/4640). + type: fix + irVersion: 53 + version: 0.41.13 + +- changelogEntry: + - summary: | + Adds availability to inlined properties for HTTP Requests, Webhooks, and WebSockets for Fern Definition and OpenAPI. + You can add availability like so: + + Fern Definition: + + ```yml + Request: + name: InlineRequest + properties: + random: + type: string + availability: pre-release + ``` + + OpenAPI: + + ```yml + requestBody: + content: + application/json: + schema: + type: object + properties: + random: + type: string + x-fern-availability: beta + ``` + type: feat + irVersion: 53 + version: 0.41.12 + +- changelogEntry: + - summary: | + Adds availability and display-names to discriminated union values. Now, in your docs, you can mark your union values + with custom names and show their availability. You can do so by adding the following to your API definition: + ```yml + MyUnionType: + union: + UnionValue1: + docs: The first union value + type: string + display-name: Union Value One + availability: beta + UnionValue2: + docs: The second union value + type: integer + display-name: Union Value Two + availability: deprecated + ``` + type: feat + irVersion: 53 + version: 0.41.11 + +- changelogEntry: + - summary: | + Adds availability and display-names to discriminated union values. Now, in your docs, you can mark your union values + with custom names and show their availability. You can do so by adding the following to your API definition: + ```yml + MyUnionType: + union: + UnionValue1: + docs: The first union value + type: string + display-name: Union Value One + availability: beta + UnionValue2: + docs: The second union value + type: integer + display-name: Union Value Two + availability: deprecated + ``` + type: feat + irVersion: 53 + version: 0.41.10 + +- changelogEntry: + - summary: | + Adds a `bundle-path` hidden parameter for `fern docs dev` for use with `fern-platform` testing. You can pass the + path on the command line as an optional parameter. + type: internal + irVersion: 53 + version: 0.41.9 + +- changelogEntry: + - summary: | + The Fern generators.yml configuration now supports a new format for namespacing APIs for additional flexibility: + + ```yml + api: + specs: + - openapi: path/to/v1/openapi + overrides: path/to/v1/overrides + namespace: v1 + - openapi: path/to/v2/openapi + overrides: path/to/v2/overrides + namespace: v2 + ``` + + Through namespacing your API, you can have multiple objects and endpoints with the same name across different namespaces. You can think of them + as the equivalent to Python modules or TypeScript packages. + type: feat + irVersion: 53 + version: 0.41.8 + +- changelogEntry: + - summary: | + Previously we weren't always awaiting PostHog API calls directly. Now the CLI + awaits these calls so that we can ensure that events are sent. + type: fix + createdAt: "2024-09-08" + irVersion: 53 + version: 0.41.7 + +- changelogEntry: + - summary: | + The Fern Docs CLI now supports OAuth 2.0 Client Credentials injection in API playgrounds. + To enable this feature, you can define the OAuth Authorization Scheme in your API configuration, + and enable the feature in your docs configuration. + + API configuration: + ```yml + api: + auth-schemes: + OAuth: + scheme: oauth + type: client-credentials + get-token: + endpoint: endpoint.authorization + ``` + [More Information](https://buildwithfern.com/learn/api-definition/fern/authentication#oauth-client-credentials) + + Docs configuration: + ```yml + navigation: + section: API Reference + playground: + oauth: true + ``` + [More Information](https://buildwithfern.com/learn/docs/api-references/customize-api-playground) + type: feat + createdAt: "2024-09-07" + irVersion: 53 + version: 0.41.6 + +- changelogEntry: + - summary: | + Fix an issue with non-deterministic file ordering when OpenAPI is used as input. + type: fix + createdAt: "2024-09-06" + irVersion: 53 + version: 0.41.5 + +- changelogEntry: + - summary: | + The Fern OpenAPI importer now handles importing an array for the `type` key. + + ``` + User: + properties: + name: + type: ["string"] + id: + type: ["string", "number"] + ``` + type: feat + createdAt: "2024-09-06" + irVersion: 53 + version: 0.41.4 + +- changelogEntry: + - summary: | + Allow referencing by method and path. For example, when configuring an + oauth scheme you can now do: + + ```oauth.yml + auth-schemes: + OAuth: + scheme: oauth + type: client-credentials + get-token: + endpoint: POST /oauth/token + api: + auth: OAuth + ``` + type: feat + createdAt: "2024-09-06" + irVersion: 53 + version: 0.41.3 + +- changelogEntry: + - summary: | + Fixes an issue introduced in `0.41.1` that ignored server urls for docs generation. + type: fix + - summary: | + Adds a `auth-schemes` and `auth` block where you can override auth for an existing spec. + See below: + + ```generators.yml + auth-schemes: + Oauth: + scheme: oauth + type: client-credentials + get-token: + endpoint: auth.get-token + api: + auth: Oauth # overrides auth scheme + specs: + - openapi: path/to/openapi + ``` + type: feat + createdAt: "2024-09-05" + irVersion: 53 + version: 0.41.2 + +- changelogEntry: + - summary: | + Adds a V2 configuration for the `api` block that is more flexible and allows + OpenAPI users to consume Fern Definition features. + + For example, now you can override environments directly in the api configuration: + ```yml + api: + environments: + Production: https://prod.com + Staging: https://staging.com + specs: + - openapi: path/to/openapi + overrides: path/to/overrides + ``` + + If you want to define, multi-url environments, those can be done by configuring the following generators.yml: + ```yml + api: + environments: + Production: + urls: + api: https://api.com + auth: https://auth.com + Staging: + api: https://stagingapi.com + auth: https://stagingauth.com + specs: + - openapi: path/to/openapi + overrides: path/to/overrides + ``` + + Note that you will need to use the `x-fern-server-name` annotation on each endpoint to assign it to a relevant server. For example, + + ```yml + paths: + /api/users/: + get: + x-fern-server-name: api + /token: + post: + x-fern-server-name: auth + ``` + type: feat + createdAt: "2024-09-04" + irVersion: 53 + version: 0.41.1 + +- changelogEntry: + - summary: | + Adds generic object declarations to the fern definition. Now we can define generics and + use them in alias declarations to minimize code duplication: + + ```yml + types: + GenericTest: + properties: + value: T + other-value: string + + GenericApplication: + type: GenericTest + ``` + + More information can be found here: https://buildwithfern.com/learn/api-definition/fern/types#generics. + type: feat + createdAt: "2024-09-04" + irVersion: 53 + version: 0.41.0 + +- changelogEntry: + - summary: | + Fix an issue where some postman environment variables (e.g. API key) were not substituted + when running fern generate. + type: fix + createdAt: "2024-09-03" + irVersion: 53 + version: 0.41.0-rc1 + +- changelogEntry: + - summary: | + Every fern folder that is using OpenAPI must configure an explicit location to the + OpenAPI spec. The location can be configured in your `generators.yml`: + + ```yml + api: + path: path/to/openapi.yml + ``` + + If you run **fern upgrade**, the CLI will automatically run a migration for you to + ensure that you are compliant! + type: break + createdAt: "2024-09-02" + irVersion: 53 + version: 0.41.0-rc0 + +- changelogEntry: + - summary: | + `fern check` allows the service base-path to be a slash. For example, the following + would be valid: + + ```yml + service: + base-path: "/" + ``` + type: fix + createdAt: "2024-09-02" + irVersion: 53 + version: 0.40.4 + +- changelogEntry: + - summary: Now `fern generator upgrade` respects the `--group` flag and only upgrades generators within a particular group. + type: fix + createdAt: "2024-09-02" + irVersion: 53 + version: 0.40.3 + +- changelogEntry: + - summary: Release IR v53.9.0 which includes a publishing configuration. + type: internal + createdAt: "2024-08-28" + irVersion: 53 + version: 0.40.2 + +- changelogEntry: + - summary: Enable specifying whether redirect in docs.yml is permanent or temporary. + type: feat + createdAt: "2024-08-28" + irVersion: 53 + version: 0.40.1 + +- changelogEntry: + - summary: Update the `fern generator upgrade` command to leverage the Generator registry API as opposed to Docker and dockerode. + type: feat + createdAt: "2024-08-28" + irVersion: 53 + version: 0.40.0 + +- changelogEntry: + - summary: The OpenAPI importer now appropriately generates examples for circular `oneOf` schemas. + type: fix + fixed: + - The OpenAPI importer now handles generating examples for referenced `oneOf` schemas. Previously, examples generation would fail. + - | + The OpenAPI importer now handles generating examples for circular `oneOf` schemas. Previously, the + the converter would only default to generating examples for the first `oneOf` schema. If the first variant, + circularly referenced itself, this would make terminating the example impossible. + Now, the example generator tries every schema in order, guaranteeing that a termination condition will be + reached. + createdAt: "2024-08-25" + irVersion: 53 + version: 0.39.19 + +- changelogEntry: + - summary: Produce IR v53.8.0 with raw datetime examples. + type: fix + fixed: + - Produce IR v53.8.0 with raw datetime examples. The raw datetime examples help when generating test fixtures to assert conditions about the original datetime. + createdAt: "2024-08-23" + irVersion: 53 + version: 0.39.18 + +- changelogEntry: + - summary: object declarations with extends and no properties now has examples propagating in the Docs and SDKs + type: fix + fixed: + - | + Previously, object declarations with extends and no properties did not have examples + propagating in the Docs and SDKs. The core issue was in IR generation which has now + been resolved. + + The following will now work as expected: + + ```yaml + types: + + ObjectWithNoProperties: + extends: + - ParentA + - ParentB + examples: + - name: Default + value: + propertyFromParentA: foo + propertyFromParentB: bar + ``` + createdAt: "2024-08-23" + irVersion: 53 + version: 0.39.17 + +- changelogEntry: + - summary: Support running 0.2.x versions of the Postman Generator with IR V53 or above. + type: chore + createdAt: "2024-08-22" + irVersion: 53 + version: 0.39.16 + +- changelogEntry: + - summary: Introduce `generator list` and `organization` commands to faciliate actions taken by `fern-bot` + type: internal + createdAt: "2024-08-21" + irVersion: 53 + version: 0.39.15 + +- changelogEntry: + - summary: Format validation is enforced on `date` fields that are specified in examples specified in an api defintion. + type: fix + createdAt: "2024-08-21" + irVersion: 53 + version: 0.39.14 + +- changelogEntry: + - summary: Generated examples in the Intermediate Representation not respect root level path parameter examples. + type: fix + fixed: + - Generated examples in the Intermediate Representation not respect root level path parameter examples. Previously, when ignored, this would result in invalid cURL examples in documentation. + createdAt: "2024-08-21" + irVersion: 53 + version: 0.39.13 + +- changelogEntry: + - summary: The mock folder now includes source files, and the CLI no longer hard fails if it cannot resolve source files that are of OpenAPI type. + type: fix + createdAt: "2024-08-20" + irVersion: 53 + version: 0.39.12 + +- changelogEntry: + - summary: The Fern CLI now handles parsing `x-fern-parameter-name` on path parameters in an OpenAPI spec. + type: fix + fixed: + - | + Fix: The Fern CLI now handles parsing `x-fern-parameter-name` on path parameters in an OpenAPI spec. For example, + if you want to rename a path parameter in the generated SDK, you can now do: + + ```yml + paths: + "/user": + get: + operationId: list_user + parameters: + - in: header + name: X-API-Version + x-fern-parameter-name: version + schema: + type: string + required: true + ``` + + For more information, please check out the [docs](https://buildwithfern.com/learn/api-definition/openapi/extensions/parameter-names). + createdAt: "2024-08-20" + irVersion: 53 + version: 0.39.11 + +- changelogEntry: + - summary: Release 0.39.10 + type: chore + createdAt: "2024-08-19" + irVersion: 53 + version: 0.39.10 +- changelogEntry: + - summary: Release 0.39.9 + type: chore + createdAt: "2024-08-19" + irVersion: 53 + version: 0.39.9 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature, csharp): Generate well-known types\ + \ by @amckinney in https://github.com/fern-api/fern/pull/4319\r\n* fix: fix\ + \ seed, move unit test to right CoreUtility by @RohinBhargava in https://github.com/fern-api/fern/pull/4324\r\ + \n* fix(openapi): generate examples with latest schemas by @dsinghvi in https://github.com/fern-api/fern/pull/4329\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.39.6...0.39.7" + type: chore + createdAt: "2024-08-18" + irVersion: 53 + version: 0.39.7 +- changelogEntry: + - summary: "## What's Changed\r\n* fix (ir): upgrade pydantic generator by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4320\r\n* fix(ir): autogenerate ir\ + \ sdks on version bump by @dsinghvi in https://github.com/fern-api/fern/pull/4321\r\ + \n* fix(python): upgrade ir sdk to handle null unknown types by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/4322\r\n* fix: add names to form data\ + \ files by @RohinBhargava in https://github.com/fern-api/fern/pull/4323\r\n\ + * fix(docs): global path parameter examples are respected by @dsinghvi in https://github.com/fern-api/fern/pull/4325\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.39.5...0.39.6" + type: chore + createdAt: "2024-08-16" + irVersion: 53 + version: 0.39.6 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): add docs for webhook inlining by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4314\r\n* (chore): add any-auth test\ + \ definition by @dsinghvi in https://github.com/fern-api/fern/pull/4297\r\n\ + * (docs): hide a page from sidebar nav and search by @dannysheridan in https://github.com/fern-api/fern/pull/4312\r\ + \n* (fix): fdr test update snapshots by @dsinghvi in https://github.com/fern-api/fern/pull/4318\r\ + \n* feat: add schema definitions for popular analytics providers to the docs\ + \ generator config by @pujitm in https://github.com/fern-api/fern/pull/4291\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.39.4...0.39.5" + type: chore + createdAt: "2024-08-15" + irVersion: 53 + version: 0.39.5 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): update ete test snapshots by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4311\r\n* bump Python generator versions\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/4308\r\n* fix:\ + \ add in asyncapi tagging with namespaces by @armandobelardo in https://github.com/fern-api/fern/pull/4313\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.39.3...0.39.4" + type: chore + createdAt: "2024-08-15" + irVersion: 53 + version: 0.39.4 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, docs): docs now respect ir base path by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/4310\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.39.2...0.39.3" + type: chore + createdAt: "2024-08-14" + irVersion: 53 + version: 0.39.3 +- changelogEntry: + - summary: "## What's Changed\r\n* feat: allow namespacing an API from generators.yml\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/4290\r\n* fix:\ + \ unions with utils re-force update refs by @armandobelardo in https://github.com/fern-api/fern/pull/4296\r\ + \n* (feature, csharp): Generate gRPC core utilities by @amckinney in https://github.com/fern-api/fern/pull/4298\r\ + \n* Update publish-docs command post-migration by @armandobelardo in https://github.com/fern-api/fern/pull/4300\r\ + \n* Run publish-docs.yml if it's updated by @armandobelardo in https://github.com/fern-api/fern/pull/4301\r\ + \n* document redirects by @chdeskur in https://github.com/fern-api/fern/pull/4299\r\ + \n* (docs): add to our Welcome page that this docs site is built with Fern by\ + \ @dannysheridan in https://github.com/fern-api/fern/pull/4307\r\n* add information\ + \ on regex redirects by @chdeskur in https://github.com/fern-api/fern/pull/4306\r\ + \n* fix: read templated env vars in the docs generator config by @pujitm in\ + \ https://github.com/fern-api/fern/pull/4287\r\n* improvement: improve `.dict`\ + \ speed by limiting dict calls by @armandobelardo in https://github.com/fern-api/fern/pull/4302\r\ + \n* improvement: python handles arrays of deep object query parameters by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4304\r\n* (fix): docs take into account\ + \ global path params and now we add tests by @dsinghvi in https://github.com/fern-api/fern/pull/4309\r\ + \n\r\n## New Contributors\r\n* @pujitm made their first contribution in https://github.com/fern-api/fern/pull/4287\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.39.1...0.39.2" + type: chore + createdAt: "2024-08-14" + irVersion: 53 + version: 0.39.2 +- changelogEntry: + - summary: "## What's Changed\r\n* chore: update fern logo by @dannysheridan in\ + \ https://github.com/fern-api/fern/pull/4295\r\n* fix (mock server): make date\ + \ comparison against true dates as opposed to string comp by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4278\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.38.1...0.39.1" + type: chore + createdAt: "2024-08-13" + irVersion: 53 + version: 0.39.1 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat, docs): add docs on `api.yml` and environment\ + \ audiences by @dsinghvi in https://github.com/fern-api/fern/pull/4292\r\n*\ + \ (fix): ir generation respects disable examples by @dsinghvi in https://github.com/fern-api/fern/pull/4293\r\ + \n* (fix, python): check autogenerated examples before indexing by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4294\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.38.0...0.38.1" + type: chore + createdAt: "2024-08-13" + irVersion: 53 + version: 0.38.1 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): retrigger typescript sdk publishing by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/4289\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.38.0-rc1...0.38.0" + type: chore + createdAt: "2024-08-12" + irVersion: 53 + version: 0.38.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat, typescript): support `hasNextPage` property\ + \ for offset pagination by @dsinghvi in https://github.com/fern-api/fern/pull/4288\r\ + \n* (feature, cli): Upload source files to S3 by @amckinney in https://github.com/fern-api/fern/pull/4286\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.38.0-rc0...0.38.0-rc1" + type: chore + createdAt: "2024-08-12" + irVersion: 53 + version: 0.38.0-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat, python): move to ruff for formatting by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/4219\r\n* improvement:\ + \ improve discriminated union object naming by @armandobelardo in https://github.com/fern-api/fern/pull/4243\r\ + \n* (feature): Add encoding and source nodes by @amckinney in https://github.com/fern-api/fern/pull/4240\r\ + \n* (feat, cli): add `has-next-page` property to IR by @dsinghvi in https://github.com/fern-api/fern/pull/4241\r\ + \n* feat (wip): add playground settings for API playground by @RohinBhargava\ + \ in https://github.com/fern-api/fern/pull/4245\r\n* fix: remove wraps from\ + \ fastapi validators by @armandobelardo in https://github.com/fern-api/fern/pull/4246\r\ + \n* fix: make model_validator take kwargs by @armandobelardo in https://github.com/fern-api/fern/pull/4247\r\ + \n* (feat): refactor how pagination properties are checked in `fern check` by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/4250\r\n* (feature): Add\ + \ support for x-fern-encoding by @amckinney in https://github.com/fern-api/fern/pull/4249\r\ + \n* (chore): Remove fhir.json by @amckinney in https://github.com/fern-api/fern/pull/4253\r\ + \n* c#, improvements: small improvements including marking files `internal`\ + \ + client classes `partial` by @dcb6 in https://github.com/fern-api/fern/pull/4248\r\ + \n* c#, improvement: Use `FluentAssertions` in unit tests by @dcb6 in https://github.com/fern-api/fern/pull/4254\r\ + \n* (feat): wire through api workspaces to docs validator by @dsinghvi in https://github.com/fern-api/fern/pull/4255\r\ + \n* (feat): upgrade to yarn v4 by @dsinghvi in https://github.com/fern-api/fern/pull/4257\r\ + \n* c#, improvements: breaking change with several small improvements by @dcb6\ + \ in https://github.com/fern-api/fern/pull/4260\r\n* feat, python: add in true\ + \ forward compat enums by @armandobelardo in https://github.com/fern-api/fern/pull/4262\r\ + \n* (feature): Copy source files in seed tests by @amckinney in https://github.com/fern-api/fern/pull/4258\r\ + \n* c#, improvement: use string response directly in generic exception by @dcb6\ + \ in https://github.com/fern-api/fern/pull/4264\r\n* (internal): `pnpm` migration\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/4261\r\n* Remove old\ + \ documentation references from README by @armandobelardo in https://github.com/fern-api/fern/pull/4265\r\ + \n* Fix typo in pr-preview.mdx by @zachkirsch in https://github.com/fern-api/fern/pull/4235\r\ + \n* (chore): Update pnpm-lock.yaml by @amckinney in https://github.com/fern-api/fern/pull/4266\r\ + \n* (fix): run compile on every PR by @dsinghvi in https://github.com/fern-api/fern/pull/4267\r\ + \n* (fix): live tests continue to work in the pnpm era by @dsinghvi in https://github.com/fern-api/fern/pull/4268\r\ + \n* (chore): Remove all yarn files by @amckinney in https://github.com/fern-api/fern/pull/4269\r\ + \n* (chore, ir): Use latest TypeScript generator by @amckinney in https://github.com/fern-api/fern/pull/4271\r\ + \n* (chore, ruby): Remove ir-sdk from generator-commons by @amckinney in https://github.com/fern-api/fern/pull/4272\r\ + \n* (fix): bump to 53.6.x by @dsinghvi in https://github.com/fern-api/fern/pull/4273\r\ + \n* (fix): get seed working by deleting yarn ref by @dsinghvi in https://github.com/fern-api/fern/pull/4274\r\ + \n* (feature, csharp): Write Protobuf dependencies in .csproj by @amckinney\ + \ in https://github.com/fern-api/fern/pull/4270\r\n* c#, fix: fix type conflicts\ + \ by @dcb6 in https://github.com/fern-api/fern/pull/4244\r\n* (fix): ir generation\ + \ for examples is stable so that ete tests work by @dsinghvi in https://github.com/fern-api/fern/pull/4276\r\ + \n* fix: add validation around selectable environments for playground settings\ + \ by @RohinBhargava in https://github.com/fern-api/fern/pull/4252\r\n* (chore,\ + \ csharp): Release 1.2.1 by @amckinney in https://github.com/fern-api/fern/pull/4284\r\ + \n* (followup): add tests for playground validation messages by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/4283\r\n* ir: add `shape` to `ExampleQueryParameter`\ + \ by @dcb6 in https://github.com/fern-api/fern/pull/4222\r\n* (fix): eslint\ + \ is now a required check and will pass by @dsinghvi in https://github.com/fern-api/fern/pull/4285\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.16...0.38.0-rc0" + type: chore + createdAt: "2024-08-12" + irVersion: 53 + version: 0.38.0-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* fix, python: make circular references more robust\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/4216\r\n* improvement:\ + \ allow naming for asyncapi messages to pull message name by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4228\r\n* c#, fix: class names +\ + \ namespace conflicts by @dcb6 in https://github.com/fern-api/fern/pull/4229\r\ + \n* Add support for anonymous usage of the generate CLI by @antoniomdk in https://github.com/fern-api/fern/pull/4239\r\ + \n* (fix, docs): filter referenced subpackages appropriately by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/4242\r\n\r\n## New Contributors\r\n\ + * @antoniomdk made their first contribution in https://github.com/fern-api/fern/pull/4239\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.15...0.37.16" + type: chore + createdAt: "2024-08-09" + irVersion: 53 + version: 0.37.16 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement: respect returning nested properties\ + \ in python by @armandobelardo in https://github.com/fern-api/fern/pull/4236\r\ + \n* (feature): Add support for `.proto` inputs by @amckinney in https://github.com/fern-api/fern/pull/4223\r\ + \n* custom segment write key by @abarrell in https://github.com/fern-api/fern/pull/4238\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.14...0.37.15" + type: chore + createdAt: "2024-08-08" + irVersion: 53 + version: 0.37.15 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: address TS UT fetcher flakiness by @RohinBhargava\ + \ in https://github.com/fern-api/fern/pull/4226\r\n* chore: bump ir sdk to new\ + \ Python generator by @armandobelardo in https://github.com/fern-api/fern/pull/4214\r\ + \n* feat: hide TOC on docs home page by @zachkirsch in https://github.com/fern-api/fern/pull/4230\r\ + \n* (fix, go): Required properties don't specify omitempty by @amckinney in\ + \ https://github.com/fern-api/fern/pull/4231\r\n* (feat, in progress): ir supports\ + \ user agent headers by @dsinghvi in https://github.com/fern-api/fern/pull/4232\r\ + \n* (fix): LaTeX by @abvthecity in https://github.com/fern-api/fern/pull/4233\r\ + \n* (feat, typescript): send user agent header `/` by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4234\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.37.13...0.37.14" + type: chore + createdAt: "2024-08-08" + irVersion: 53 + version: 0.37.14 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: address TS UT fetcher flakiness by @RohinBhargava\ + \ in https://github.com/fern-api/fern/pull/4226\r\n* chore: bump ir sdk to new\ + \ Python generator by @armandobelardo in https://github.com/fern-api/fern/pull/4214\r\ + \n* feat: hide TOC on docs home page by @zachkirsch in https://github.com/fern-api/fern/pull/4230\r\ + \n* (fix, go): Required properties don't specify omitempty by @amckinney in\ + \ https://github.com/fern-api/fern/pull/4231\r\n* (feat, in progress): ir supports\ + \ user agent headers by @dsinghvi in https://github.com/fern-api/fern/pull/4232\r\ + \n* (fix): LaTeX by @abvthecity in https://github.com/fern-api/fern/pull/4233\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.13...0.37.14-rc0" + type: chore + createdAt: "2024-08-08" + irVersion: 53 + version: 0.37.14-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): reload docs preview server on specs outside\ + \ of the fern folder by @dsinghvi in https://github.com/fern-api/fern/pull/4227\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.12...0.37.13" + type: chore + createdAt: "2024-08-07" + irVersion: 53 + version: 0.37.13 +- changelogEntry: + - summary: "## What's Changed\r\n* update cli to use default language by @abarrell\ + \ in https://github.com/fern-api/fern/pull/4218\r\n* (fix, openapi parser):\ + \ generated fern definitions respect OpenAPI tag casing by @dsinghvi in https://github.com/fern-api/fern/pull/4225\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.11...0.37.12" + type: chore + createdAt: "2024-08-07" + irVersion: 53 + version: 0.37.12 +- changelogEntry: + - summary: "## What's Changed\r\n* Fix issue where misconfigured directory could\ + \ cause unhelpful error message by @abarrell in https://github.com/fern-api/fern/pull/4206\r\ + \n\r\n## New Contributors\r\n* @abarrell made their first contribution in https://github.com/fern-api/fern/pull/4206\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.10...0.37.11" + type: chore + createdAt: "2024-08-07" + irVersion: 53 + version: 0.37.11 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: if audience is filtering and no audiences\ + \ exist on environments, add all environments by @RohinBhargava in https://github.com/fern-api/fern/pull/4220\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.9...0.37.10" + type: chore + createdAt: "2024-08-06" + irVersion: 53 + version: 0.37.10 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): support base properties when filtering\ + \ for audiences by @dsinghvi in https://github.com/fern-api/fern/pull/4221\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.8...0.37.9" + type: chore + createdAt: "2024-08-06" + irVersion: 53 + version: 0.37.9 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat): cli caches api dependencies by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4201\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.37.7...0.37.8" + type: chore + createdAt: "2024-08-06" + irVersion: 53 + version: 0.37.8 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: python readme generation regression by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4193\r\n* fix, python: allow extending\ + \ alias types by @armandobelardo in https://github.com/fern-api/fern/pull/4190\r\ + \n* (internal): setup flamegraph generation for python generator by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4196\r\n* fix, python: Optional and\ + \ aliased literals are populated in snippets by @armandobelardo in https://github.com/fern-api/fern/pull/4184\r\ + \n* (feat, python): upgrade python generator to pydantic v2 by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/4197\r\n* fix: add async iterable symbol\ + \ to Stream Wrapper implementations by @RohinBhargava in https://github.com/fern-api/fern/pull/4195\r\ + \n* feat: environment filter by audience by @RohinBhargava in https://github.com/fern-api/fern/pull/4187\r\ + \n* (feat, python): use ruff for formatting by @dsinghvi in https://github.com/fern-api/fern/pull/4199\r\ + \n* Revert \"(feat, python): use ruff for formatting\" by @dsinghvi in https://github.com/fern-api/fern/pull/4200\r\ + \n* fix, python + ts: additional template bugs by @armandobelardo in https://github.com/fern-api/fern/pull/4198\r\ + \n* fix: remove reserved properties from function signatures by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4205\r\n* fix, ir-generation: put\ + \ fully substituted path in `url` field of auto-generated `EndpointExampleCall`s\ + \ by @dcb6 in https://github.com/fern-api/fern/pull/4211\r\n* fix, python: allow\ + \ typing any to be wrapped in optional to match Pydantic v2 by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4203\r\n* improvement: bring back\ + \ wrapped aliases and custom root validators in\u2026 by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/4204\r\n* fix: typehinting on unions\ + \ with visitors has been corrected by @armandobelardo in https://github.com/fern-api/fern/pull/4213\r\ + \n* Update speakeasy.mdx by @dannysheridan in https://github.com/fern-api/fern/pull/4215\r\ + \n* improvement: allow pydantic generator to specify package name by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4217\r\n* (feature): Add Protobuf\ + \ mapper types by @amckinney in https://github.com/fern-api/fern/pull/4210\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.6...0.37.7" + type: chore + createdAt: "2024-08-06" + irVersion: 53 + version: 0.37.7 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: add literal properties back to typeddict\ + \ snippets by @armandobelardo in https://github.com/fern-api/fern/pull/4173\r\ + \n* (fix, typescript): wire `noScripts` into a PersistedProject and introduce\ + \ a test by @dsinghvi in https://github.com/fern-api/fern/pull/4185\r\n* (feat,\ + \ fastapi): introduce endpoint specific async handlers in fastapi by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4188\r\n* fix: python readme references\ + \ request options correctly by @armandobelardo in https://github.com/fern-api/fern/pull/4189\r\ + \n* fix: replace referenced markdown by @abvthecity in https://github.com/fern-api/fern/pull/4191\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.5...0.37.6" + type: chore + createdAt: "2024-08-02" + irVersion: 53 + version: 0.37.6 +- changelogEntry: + - summary: "## What's Changed\r\n* chore, ts: generate union v2 templates by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4169\r\n* (feature, csharp): Add\ + \ customizable exception class names by @amckinney in https://github.com/fern-api/fern/pull/4181\r\ + \n* (fix, typescript): introduce no scripts option by @dsinghvi in https://github.com/fern-api/fern/pull/4179\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.4...0.37.5" + type: chore + createdAt: "2024-08-01" + irVersion: 53 + version: 0.37.5 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, docs): validate api workspaces as in addition\ + \ to docs workspaces by @dsinghvi in https://github.com/fern-api/fern/pull/4178\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.3...0.37.4" + type: chore + createdAt: "2024-08-01" + irVersion: 53 + version: 0.37.4 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): handle loggable fern cli error by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4175\r\n* (fix): add tests for alias\ + \ extends by @dsinghvi in https://github.com/fern-api/fern/pull/4176\r\n* (fix):\ + \ docs preview server falls back to previous bundle by @dsinghvi in https://github.com/fern-api/fern/pull/4177\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.2...0.37.3" + type: chore + createdAt: "2024-08-01" + irVersion: 53 + version: 0.37.3 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature, csharp): Add RequestOptions by @amckinney\ + \ in https://github.com/fern-api/fern/pull/4166\r\n* c#, improvement: error\ + \ parsing by @dcb6 in https://github.com/fern-api/fern/pull/4168\r\n* (fix):\ + \ introduce extended properties into the IR by @dsinghvi in https://github.com/fern-api/fern/pull/4171\r\ + \n* fix: OSS workspace settings propogate to APIs with dependencies by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4147\r\n* chore, python: generate\ + \ union v2 templates by @armandobelardo in https://github.com/fern-api/fern/pull/4167\r\ + \n* c# improvement: text responses + inlined request body inheritance by @dcb6\ + \ in https://github.com/fern-api/fern/pull/4172\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.37.1...0.37.2" + type: chore + createdAt: "2024-08-01" + irVersion: 53 + version: 0.37.2 +- changelogEntry: + - summary: "## What's Changed\r\n* make @dcb6 codeowner for java + csharp by @dcb6\ + \ in https://github.com/fern-api/fern/pull/4163\r\n* (beta, typescript): feature\ + \ flag test generation that actually works by @dsinghvi in https://github.com/fern-api/fern/pull/4164\r\ + \n* fix: add images from frontmatter as well by @RohinBhargava in https://github.com/fern-api/fern/pull/4156\r\ + \n* (fix, docs): ir to fdr converter sends global headers by @dsinghvi in https://github.com/fern-api/fern/pull/4170\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.37.0...0.37.1" + type: chore + createdAt: "2024-07-31" + irVersion: 53 + version: 0.37.1 +- changelogEntry: + - summary: "## What's Changed\r\n* chore: bump typescript version and changelog\ + \ by @RohinBhargava in https://github.com/fern-api/fern/pull/4143\r\n* feat:\ + \ introduce typeddicts for request objects by @armandobelardo in https://github.com/fern-api/fern/pull/4113\r\ + \n* fix, python: get api error through external import by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/4145\r\n* fix: Fix unit test path and\ + \ add CI check for this by @RohinBhargava in https://github.com/fern-api/fern/pull/4148\r\ + \n* [c#, improvement]: add explicit namespaces to custom config by @dcb6 in\ + \ https://github.com/fern-api/fern/pull/4144\r\n* c#, improvement: `set` instead\ + \ of `init` field accessors in types by @dcb6 in https://github.com/fern-api/fern/pull/4151\r\ + \n* (feature): Add IRv53; float type by @amckinney in https://github.com/fern-api/fern/pull/4146\r\ + \n* c#, improvement: make datetime deserialization more lenient + include millis\ + \ in datetime serialization by @dcb6 in https://github.com/fern-api/fern/pull/4149\r\ + \n* chore: ci workflow gating on ts-sdk changes by @RohinBhargava in https://github.com/fern-api/fern/pull/4152\r\ + \n* (fix, csharp): `map` values are nullable by @amckinney in\ + \ https://github.com/fern-api/fern/pull/4153\r\n* fix: incorrect code block\ + \ indentation in api-yml.mdx by @abvthecity in https://github.com/fern-api/fern/pull/4158\r\ + \n* (feature, csharp): Add support for allow-multiple query params by @amckinney\ + \ in https://github.com/fern-api/fern/pull/4157\r\n* internal: update IR to\ + \ have the FDR API definition ID by @armandobelardo in https://github.com/fern-api/fern/pull/4161\r\ + \n* (feature, csharp): Support uint, ulong, and float by @amckinney in https://github.com/fern-api/fern/pull/4160\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.36.0...0.37.0" + type: chore + createdAt: "2024-07-31" + irVersion: 53 + version: 0.37.0 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement, python: export the root client from\ + \ the root init file by @armandobelardo in https://github.com/fern-api/fern/pull/4111\r\ + \n* (feat): support multi url environments in C# by @dsinghvi in https://github.com/fern-api/fern/pull/4120\r\ + \n* (fix, csharp): MultiUrl environments now compile by @dsinghvi in https://github.com/fern-api/fern/pull/4121\r\ + \n* c#, improvement: Add header suppliers to `RawClient` constructor parameters\ + \ by @dcb6 in https://github.com/fern-api/fern/pull/4119\r\n* (fix, csharp):\ + \ uuids are now generated as strings by @dsinghvi in https://github.com/fern-api/fern/pull/4122\r\ + \n* (fix): regenerate c# model snapshots by @dsinghvi in https://github.com/fern-api/fern/pull/4123\r\ + \n* feat: header tabs by @abvthecity in https://github.com/fern-api/fern/pull/4124\r\ + \n* java, fix: match java local config to publish config by @dcb6 in https://github.com/fern-api/fern/pull/4127\r\ + \n* follow up: release java sdk 1.0.5 by @dcb6 in https://github.com/fern-api/fern/pull/4129\r\ + \n* fix: Add Stream Wrappers for use with various environments by @RohinBhargava\ + \ in https://github.com/fern-api/fern/pull/4118\r\n* chore: add changelog and\ + \ version for stream wrapper polyfill by @RohinBhargava in https://github.com/fern-api/fern/pull/4130\r\ + \n* feat: enable arbitrary code snippets in docs by @abvthecity in https://github.com/fern-api/fern/pull/4131\r\ + \n* fix: add start stream on pipe by @RohinBhargava in https://github.com/fern-api/fern/pull/4132\r\ + \n* GH Workflow for Checking Generator Version Consistency by @dcb6 in https://github.com/fern-api/fern/pull/4133\r\ + \n* fix: updated stream wrapper test paths by @RohinBhargava in https://github.com/fern-api/fern/pull/4134\r\ + \n* fix: SSE Streaming Bifurcation by @RohinBhargava in https://github.com/fern-api/fern/pull/4136\r\ + \n* (fix): global headers case insensitive comparison by @dsinghvi in https://github.com/fern-api/fern/pull/4137\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.35.0...0.36.0" + type: chore + createdAt: "2024-07-29" + irVersion: 52 + version: 0.36.0 +- changelogEntry: + - summary: "## What's Changed\r\n* java, fix: match java local config to publish\ + \ config by @dcb6 in https://github.com/fern-api/fern/pull/4127\r\n* follow\ + \ up: release java sdk 1.0.5 by @dcb6 in https://github.com/fern-api/fern/pull/4129\r\ + \n* fix: Add Stream Wrappers for use with various environments by @RohinBhargava\ + \ in https://github.com/fern-api/fern/pull/4118\r\n* chore: add changelog and\ + \ version for stream wrapper polyfill by @RohinBhargava in https://github.com/fern-api/fern/pull/4130\r\ + \n* feat: enable arbitrary code snippets in docs by @abvthecity in https://github.com/fern-api/fern/pull/4131\r\ + \n* fix: add start stream on pipe by @RohinBhargava in https://github.com/fern-api/fern/pull/4132\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.36.0-rc0...0.36.0-rc1" + type: chore + createdAt: "2024-07-26" + irVersion: 52 + version: 0.36.0-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement, python: export the root client from\ + \ the root init file by @armandobelardo in https://github.com/fern-api/fern/pull/4111\r\ + \n* (feat): support multi url environments in C# by @dsinghvi in https://github.com/fern-api/fern/pull/4120\r\ + \n* (fix, csharp): MultiUrl environments now compile by @dsinghvi in https://github.com/fern-api/fern/pull/4121\r\ + \n* c#, improvement: Add header suppliers to `RawClient` constructor parameters\ + \ by @dcb6 in https://github.com/fern-api/fern/pull/4119\r\n* (fix, csharp):\ + \ uuids are now generated as strings by @dsinghvi in https://github.com/fern-api/fern/pull/4122\r\ + \n* (fix): regenerate c# model snapshots by @dsinghvi in https://github.com/fern-api/fern/pull/4123\r\ + \n* feat: header tabs by @abvthecity in https://github.com/fern-api/fern/pull/4124\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.35.0...0.36.0-rc0" + type: chore + createdAt: "2024-07-26" + irVersion: 52 + version: 0.36.0-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat): support `default-url` and url override\ + \ on imports by @dsinghvi in https://github.com/fern-api/fern/pull/4116\r\n\ + * (fix, openapi): set unauthed appropriately in openapi parser by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4117\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.34.0...0.35.0" + type: chore + createdAt: "2024-07-25" + irVersion: 52 + version: 0.35.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat): support `default-url` and url override\ + \ on imports by @dsinghvi in https://github.com/fern-api/fern/pull/4116\r\n\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.34.0...0.35.0-rc0" + type: chore + createdAt: "2024-07-24" + irVersion: 52 + version: 0.35.0-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore): add SEO frontmatter section by @chdeskur\ + \ in https://github.com/fern-api/fern/pull/4101\r\n* fix: update typing of `expected_types`\ + \ to tuple to satisfy mypy by @armandobelardo in https://github.com/fern-api/fern/pull/4100\r\ + \n* (chore): document nuget api key by @chdeskur in https://github.com/fern-api/fern/pull/4103\r\ + \n* (chore): pypi styling update by @chdeskur in https://github.com/fern-api/fern/pull/4105\r\ + \n* c#, improvement: datetime serialization by @dcb6 in https://github.com/fern-api/fern/pull/4106\r\ + \n* feat: disable batch/stream toggle by @abvthecity in https://github.com/fern-api/fern/pull/4108\r\ + \n* fix: update forward refs continues to be silent by @armandobelardo in https://github.com/fern-api/fern/pull/4110\r\ + \n* java, improvement: allow builder methods for optional fields to accept null\ + \ by @dcb6 in https://github.com/fern-api/fern/pull/4107\r\n* [FER-2381] CLI\ + \ Forbidden Error Message Improvement by @RohinBhargava in https://github.com/fern-api/fern/pull/4109\r\ + \n* (feat, typescript): copy over `zurg` unit tests to the generated SDK by\ + \ @williamluer in https://github.com/fern-api/fern/pull/4045\r\n* java, fix:\ + \ don't prematurely close okhttp response by @dcb6 in https://github.com/fern-api/fern/pull/4112\r\ + \n* (feat, typescript): generate tests for `auth` and `fetcher` utilities by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/4115\r\n* (feature): Add\ + \ IRv52: uint and enum default values by @amckinney in https://github.com/fern-api/fern/pull/4102\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.33.5...0.34.0" + type: chore + createdAt: "2024-07-24" + irVersion: 52 + version: 0.34.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore): add SEO frontmatter section by @chdeskur\ + \ in https://github.com/fern-api/fern/pull/4101\r\n* fix: update typing of `expected_types`\ + \ to tuple to satisfy mypy by @armandobelardo in https://github.com/fern-api/fern/pull/4100\r\ + \n* (chore): document nuget api key by @chdeskur in https://github.com/fern-api/fern/pull/4103\r\ + \n* (chore): pypi styling update by @chdeskur in https://github.com/fern-api/fern/pull/4105\r\ + \n* c#, improvement: datetime serialization by @dcb6 in https://github.com/fern-api/fern/pull/4106\r\ + \n* feat: disable batch/stream toggle by @abvthecity in https://github.com/fern-api/fern/pull/4108\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.33.5...0.33.6-rc0" + type: chore + createdAt: "2024-07-24" + irVersion: 51 + version: 0.33.6-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, go): Fix error handling for property-name\ + \ error discrimination by @amckinney in https://github.com/fern-api/fern/pull/4098\r\ + \n* improvement: support pydantic v2 outright by @armandobelardo in https://github.com/fern-api/fern/pull/3805\r\ + \n* fix: int64 format is correctly parsed to long by @armandobelardo in https://github.com/fern-api/fern/pull/4099\r\ + \n* c#, fix: fix datetime serialization, stop generating empty serialization\ + \ unit tests by @dcb6 in https://github.com/fern-api/fern/pull/4097\r\n* [FER-2339]\ + \ Pass OpenAPI request parameter examples through Fern IR Schema examples by\ + \ @RohinBhargava in https://github.com/fern-api/fern/pull/4095\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.33.4...0.33.5" + type: chore + createdAt: "2024-07-23" + irVersion: 51 + version: 0.33.5 +- changelogEntry: + - summary: "## What's Changed\r\n* adding readme alternative page by @chdeskur in\ + \ https://github.com/fern-api/fern/pull/4091\r\n* fix: the ruby SDK now returns\ + \ the parsed json instead of openstruct if no JSON serializer is specified by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/4092\r\n* (fix):\ + \ OpenAPI parser handles generating examples when no request or response required\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/4096\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.33.3...0.33.4" + type: chore + createdAt: "2024-07-22" + irVersion: 51 + version: 0.33.4 +- changelogEntry: + - summary: "## What's Changed\r\n* feat, csharp: Unit Test Generation + IR Bump\ + \ by @dcb6 in https://github.com/fern-api/fern/pull/4047\r\n* (fix): remove\ + \ `jest-specific-snapshot` by @dsinghvi in https://github.com/fern-api/fern/pull/4088\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.33.2...0.33.3" + type: chore + createdAt: "2024-07-21" + irVersion: 51 + version: 0.33.3 +- changelogEntry: + - summary: "## What's Changed\r\n* fix, python: only check the oauth expiry if there\ + \ is a specified field by @armandobelardo in https://github.com/fern-api/fern/pull/4077\r\ + \n* fix: python now requires an environment be specified if a default is not\ + \ provided by @armandobelardo in https://github.com/fern-api/fern/pull/4078\r\ + \n* (feat): support `fs.CreateReadStream` on Node 19+ form data uploads by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4073\r\n* (fix): support audiences\ + \ on query parameters by @dsinghvi in https://github.com/fern-api/fern/pull/4067\r\ + \n* (feat, cli): Add \"-\", \"/\", \"|\" to supported non-alphanumeric generated\ + \ names for Enums by @dsinghvi in https://github.com/fern-api/fern/pull/4084\r\ + \n* improvement: update 'any object' examples to be flatter by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4083\r\n* improvement: global headers\ + \ are not extracted out for docs by @armandobelardo in https://github.com/fern-api/fern/pull/4085\r\ + \n* chore: implement stream-parameter IR change by @armandobelardo in https://github.com/fern-api/fern/pull/4072\r\ + \n* (chore, csharp): Generate latest test snapshots by @amckinney in https://github.com/fern-api/fern/pull/4087\r\ + \n* improvement: Add Availability to OpenApi Parser and OpenApi IR to Fern IR\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/4086\r\n\r\n\r\ + \n**Full Changelog**: https://github.com/fern-api/fern/compare/0.33.1...0.33.2" + type: chore + createdAt: "2024-07-19" + irVersion: 51 + version: 0.33.2 +- changelogEntry: + - summary: "## What's Changed\r\n* fix, python: only check the oauth expiry if there\ + \ is a specified field by @armandobelardo in https://github.com/fern-api/fern/pull/4077\r\ + \n* fix: python now requires an environment be specified if a default is not\ + \ provided by @armandobelardo in https://github.com/fern-api/fern/pull/4078\r\ + \n* (feat): support `fs.CreateReadStream` on Node 19+ form data uploads by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4073\r\n* (fix): support audiences\ + \ on query parameters by @dsinghvi in https://github.com/fern-api/fern/pull/4067\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.33.1...0.33.2-rc0" + type: chore + createdAt: "2024-07-19" + irVersion: 51 + version: 0.33.2-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* :improvement: update seed's script runner to\ + \ fail if any of the commands exit 1 by @armandobelardo in https://github.com/fern-api/fern/pull/4075\r\ + \n* (fix, openapi): Deduplicate API version scheme header by @amckinney in https://github.com/fern-api/fern/pull/4076\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.33.0...0.33.1" + type: chore + createdAt: "2024-07-17" + irVersion: 51 + version: 0.33.1 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: python sdk serializes bytes within JSON\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/4070\r\n* (fix,\ + \ typescript): multipart form upload on Node 19+ by @dsinghvi in https://github.com/fern-api/fern/pull/4056\r\ + \n* (feat): `ir` now adds a `TypeReference` for container types that makes it\ + \ easier to generate snippets + autogenerated type examples by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/4038\r\n* (fix): fix `ir-sdk-latest`\ + \ `generators.yml` by @dcb6 in https://github.com/fern-api/fern/pull/4074\r\n\ + * (feature, typescript): Generarte API version scheme by @amckinney in https://github.com/fern-api/fern/pull/4071\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.32.0...0.33.0" + type: chore + createdAt: "2024-07-17" + irVersion: 51 + version: 0.33.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, openapi): Resolve 'refs' specified in overrides\ + \ by @amckinney in https://github.com/fern-api/fern/pull/4049\r\n* Initial Swift\ + \ Codegen by @armandobelardo in https://github.com/fern-api/fern/pull/4035\r\ + \n* (fix): Swift generator and template by @amckinney in https://github.com/fern-api/fern/pull/4050\r\ + \n* fix: ignore data urls in parseImagePaths by @abvthecity in https://github.com/fern-api/fern/pull/4053\r\ + \n* (feature, typescript): Add omitUndefined option by @amckinney in https://github.com/fern-api/fern/pull/4052\r\ + \n* docs: Inspiration from Conjure, Smithy, and Stripe Docs by @dannysheridan\ + \ in https://github.com/fern-api/fern/pull/4054\r\n* feature: add Penguin AI\ + \ and Koala to our docs website by @dannysheridan in https://github.com/fern-api/fern/pull/3962\r\ + \n* (fix): eslint works by @dsinghvi in https://github.com/fern-api/fern/pull/4055\r\ + \n* fix: python snippet and template recursion errors by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/4057\r\n* (feature, typescript): Use\ + \ generator-cli to generate reference.md by @amckinney in https://github.com/fern-api/fern/pull/4062\r\ + \n* fix: analytics scripts by @abvthecity in https://github.com/fern-api/fern/pull/4063\r\ + \n* fix analytics 2 by @abvthecity in https://github.com/fern-api/fern/pull/4064\r\ + \n* fix: fern docs publishing by @abvthecity in https://github.com/fern-api/fern/pull/4065\r\ + \n* feature: add tracking via rb2b by @dannysheridan in https://github.com/fern-api/fern/pull/4061\r\ + \n* chore: add back x-readme code samples by @armandobelardo in https://github.com/fern-api/fern/pull/4060\r\ + \n* (feature): Add ApiVersionSchema type by @amckinney in https://github.com/fern-api/fern/pull/4068\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.24...0.32.0" + type: chore + createdAt: "2024-07-16" + irVersion: 50 + version: 0.32.0 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: ignore data urls in parseImagePaths by @abvthecity\ + \ in https://github.com/fern-api/fern/pull/4053\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.31.25-rc0...0.31.25-rc1" + type: chore + createdAt: "2024-07-12" + irVersion: 50 + version: 0.31.25-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, openapi): Resolve 'refs' specified in overrides\ + \ by @amckinney in https://github.com/fern-api/fern/pull/4049\r\n* Initial Swift\ + \ Codegen by @armandobelardo in https://github.com/fern-api/fern/pull/4035\r\ + \n* (fix): Swift generator and template by @amckinney in https://github.com/fern-api/fern/pull/4050\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.24...0.31.25-rc0" + type: chore + createdAt: "2024-07-12" + irVersion: 50 + version: 0.31.25-rc0 +- changelogEntry: + - summary: Release 0.31.24 + type: chore + createdAt: "2024-07-12" + irVersion: 50 + version: 0.31.24 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature, typescript): Add setObjectProperty\ + \ core utility by @amckinney in https://github.com/fern-api/fern/pull/4032\r\ + \n* c#, fix: increase supported union size + handle double optionals by @dcb6\ + \ in https://github.com/fern-api/fern/pull/4033\r\n* (fix): Handle circular\ + \ references in serialization layer by @amckinney in https://github.com/fern-api/fern/pull/4036\r\ + \n* fix: fastapi generation does not duplicate descriptions anymore by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4037\r\n* Move use_str_enums to base\ + \ by @jochs in https://github.com/fern-api/fern/pull/4040\r\n* (chore): remove\ + \ generator upgrade docs by @chdeskur in https://github.com/fern-api/fern/pull/4043\r\ + \n* (feature, openapi): Add support for x-fern-property-name on request body\ + \ by @amckinney in https://github.com/fern-api/fern/pull/4042\r\n* (feat, typescript):\ + \ refactor `Fetcher` and add unit tests by @williamluer in https://github.com/fern-api/fern/pull/3977\r\ + \n\r\n## New Contributors\r\n* @jochs made their first contribution in https://github.com/fern-api/fern/pull/4040\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.22...0.31.23" + type: chore + createdAt: "2024-07-11" + irVersion: 50 + version: 0.31.23 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature, typescript): Add setObjectProperty\ + \ core utility by @amckinney in https://github.com/fern-api/fern/pull/4032\r\ + \n* c#, fix: increase supported union size + handle double optionals by @dcb6\ + \ in https://github.com/fern-api/fern/pull/4033\r\n* (fix): Handle circular\ + \ references in serialization layer by @amckinney in https://github.com/fern-api/fern/pull/4036\r\ + \n* fix: fastapi generation does not duplicate descriptions anymore by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/4037\r\n* (feat): ir now adds a TypeReference\ + \ for container types that makes it easier to generate snippets by @dcb6 in\ + \ https://github.com/fern-api/fern/pull/4038\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.31.22...0.31.23-rc0" + type: chore + createdAt: "2024-07-11" + irVersion: 50 + version: 0.31.23-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* Revert \"Revert \"feat: landing page in docs\"\ + \" by @abvthecity in https://github.com/fern-api/fern/pull/4023\r\n* Fix core-utilities\ + \ typescript tests by @williamluer in https://github.com/fern-api/fern/pull/4022\r\ + \n* experimental: scan files to include react in mdx by @abvthecity in https://github.com/fern-api/fern/pull/4015\r\ + \n* (feat, typescript): make `zurg` completely synchronous by @dsinghvi in https://github.com/fern-api/fern/pull/4024\r\ + \n* (chore): add xml type by @chdeskur in https://github.com/fern-api/fern/pull/4025\r\ + \n* fix: (regression) parseDocsConfiguration accidentally calls loadAllPages\ + \ with absolutePathToDocsConfig by @abvthecity in https://github.com/fern-api/fern/pull/4026\r\ + \n* (feature, typescript): Add offset step pagination with IRv48 by @amckinney\ + \ in https://github.com/fern-api/fern/pull/4028\r\n* csharp, fix, feature, improvment:\ + \ Target .NET Standard + Framework, fix various bugs, many small improvements\ + \ by @dcb6 in https://github.com/fern-api/fern/pull/4030\r\n* fix: update unchecked\ + \ base model to not coerce none by @armandobelardo in https://github.com/fern-api/fern/pull/4029\r\ + \n* fix: unreserve `set` name for python methods by @armandobelardo in https://github.com/fern-api/fern/pull/4031\r\ + \n* add in swift to seed runner by @armandobelardo in https://github.com/fern-api/fern/pull/4034\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.21...0.31.22" + type: chore + createdAt: "2024-07-10" + irVersion: 50 + version: 0.31.22 +- changelogEntry: + - summary: "## What's Changed\r\n* Fix core-utilities typescript tests by @williamluer\ + \ in https://github.com/fern-api/fern/pull/4022\r\n* experimental: scan files\ + \ to include react in mdx by @abvthecity in https://github.com/fern-api/fern/pull/4015\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.22-rc0...0.31.22-rc1" + type: chore + createdAt: "2024-07-09" + irVersion: 50 + version: 0.31.22-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat, typescript): make `zurg` completely synchronous\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/4024\r\n* (chore): add\ + \ xml type by @chdeskur in https://github.com/fern-api/fern/pull/4025\r\n* fix:\ + \ (regression) parseDocsConfiguration accidentally calls loadAllPages with absolutePathToDocsConfig\ + \ by @abvthecity in https://github.com/fern-api/fern/pull/4026\r\n* (feature,\ + \ typescript): Add offset step pagination with IRv48 by @amckinney in https://github.com/fern-api/fern/pull/4028\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.22-rc1...0.31.22-rc2" + type: chore + createdAt: "2024-07-09" + irVersion: 50 + version: 0.31.22-rc2 +- changelogEntry: + - summary: "## What's Changed\r\n* Revert \"Revert \"feat: landing page in docs\"\ + \" by @abvthecity in https://github.com/fern-api/fern/pull/4023\r\n\r\n\r\n\ + **Full Changelog**: https://github.com/fern-api/fern/compare/0.31.21...0.31.22-rc0" + type: chore + createdAt: "2024-07-09" + irVersion: 50 + version: 0.31.22-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore, typescript): Release 0.28.0-rc0 by @amckinney\ + \ in https://github.com/fern-api/fern/pull/4019\r\n* Revert \"feat: landing\ + \ page in docs\" by @dsinghvi in https://github.com/fern-api/fern/pull/4021\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.20...0.31.21" + type: chore + createdAt: "2024-07-09" + irVersion: 50 + version: 0.31.21 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature, typescript): Add offset pagination\ + \ by @amckinney in https://github.com/fern-api/fern/pull/4008\r\n* (fix, internal):\ + \ `template/codegen` repo plays nicely with mrlint by @dsinghvi in https://github.com/fern-api/fern/pull/4018\r\ + \n* (fix): CI is green by @amckinney in https://github.com/fern-api/fern/pull/4017\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.19...0.31.20" + type: chore + createdAt: "2024-07-09" + irVersion: 50 + version: 0.31.20 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): Pagination works with imported type references\ + \ by @amckinney in https://github.com/fern-api/fern/pull/4014\r\n* Template\ + \ for creating a new SDK generator by @mikemilla in https://github.com/fern-api/fern/pull/4010\r\ + \n\r\n## New Contributors\r\n* @mikemilla made their first contribution in https://github.com/fern-api/fern/pull/4010\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.18...0.31.19" + type: chore + createdAt: "2024-07-09" + irVersion: 50 + version: 0.31.19 +- changelogEntry: + - summary: "## What's Changed\r\n* feat: landing page in docs by @abvthecity in\ + \ https://github.com/fern-api/fern/pull/3999\r\n* (feature, typescript): Add\ + \ support for alpha/beta dist tags by @amckinney in https://github.com/fern-api/fern/pull/4000\r\ + \n* fix: allowed text encodings by @abvthecity in https://github.com/fern-api/fern/pull/4005\r\ + \n* (internal): get ci to green by @dsinghvi in https://github.com/fern-api/fern/pull/4009\r\ + \n* (feat, typescript): support jsr publish by @dsinghvi in https://github.com/fern-api/fern/pull/4007\r\ + \n* (chore, python): Update README.md snapshots by @amckinney in https://github.com/fern-api/fern/pull/4012\r\ + \n* (chore, check): Add pagination test cases by @amckinney in https://github.com/fern-api/fern/pull/4011\r\ + \n* (fix, typescript): readme correctly displays advanced sections by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/4013\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.31.17...0.31.18-rc0" + type: chore + createdAt: "2024-07-09" + irVersion: 50 + version: 0.31.18 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore): Replace CircleCI with GitHub workflows\ + \ by @amckinney in https://github.com/fern-api/fern/pull/3991\r\n* (fix): Update\ + \ NPM token envrionment variable by @amckinney in https://github.com/fern-api/fern/pull/3992\r\ + \n* (fix): Update git-version.sh script by @amckinney in https://github.com/fern-api/fern/pull/3993\r\ + \n* (fix): Use github.ref_name by @amckinney in https://github.com/fern-api/fern/pull/3996\r\ + \n* (fix): Add POSTHOG_API_KEY to live-test job by @amckinney in https://github.com/fern-api/fern/pull/3998\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.15...0.31.17" + type: chore + createdAt: "2024-07-05" + irVersion: 50 + version: 0.31.17 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): Add POSTHOG_API_KEY to live-test job by\ + \ @amckinney in https://github.com/fern-api/fern/pull/3998\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.31.17-rc1...0.31.17-rc2" + type: chore + createdAt: "2024-07-05" + irVersion: 50 + version: 0.31.17-rc2 +- changelogEntry: + - summary: + "## What's Changed\r\n* (fix): Use github.ref_name by @amckinney in https://github.com/fern-api/fern/pull/3996\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.17-rc0...0.31.17-rc1" + type: chore + createdAt: "2024-07-05" + irVersion: 50 + version: 0.31.17-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore): Replace CircleCI with GitHub workflows\ + \ by @amckinney in https://github.com/fern-api/fern/pull/3991\r\n* (fix): Update\ + \ NPM token envrionment variable by @amckinney in https://github.com/fern-api/fern/pull/3992\r\ + \n* (fix): Update git-version.sh script by @amckinney in https://github.com/fern-api/fern/pull/3993\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.15...0.31.17-rc0" + type: chore + createdAt: "2024-07-05" + irVersion: 50 + version: 0.31.17-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore): update availability.mdx by @chdeskur\ + \ in https://github.com/fern-api/fern/pull/3989\r\n* (fix, openapi): Fix allOf\ + \ object filtering by @amckinney in https://github.com/fern-api/fern/pull/3990\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.14...0.31.16" + type: chore + createdAt: "2024-07-05" + irVersion: 50 + version: 0.31.16 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore): update availability.mdx by @chdeskur\ + \ in https://github.com/fern-api/fern/pull/3989\r\n* (fix, openapi): Fix allOf\ + \ object filtering by @amckinney in https://github.com/fern-api/fern/pull/3990\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.14...0.31.15" + type: chore + createdAt: "2024-07-05" + irVersion: 50 + version: 0.31.15 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, go): Don't send 'null' for nil request\ + \ body by @amckinney in https://github.com/fern-api/fern/pull/3987\r\n* (fix):\ + \ fern generate --preview doesnt check for env variables by @dsinghvi in https://github.com/fern-api/fern/pull/3988\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.13...0.31.14" + type: chore + createdAt: "2024-07-04" + irVersion: 50 + version: 0.31.14 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): allow ISO-8859-1 encoded files by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3986\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.31.12...0.31.13" + type: chore + createdAt: "2024-07-04" + irVersion: 50 + version: 0.31.13 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, cli): Remove default value checks for boolean,\ + \ long, and bigint by @amckinney in https://github.com/fern-api/fern/pull/3985\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.11...0.31.12" + type: chore + createdAt: "2024-07-04" + irVersion: 50 + version: 0.31.12 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: ruby snippets for dates have correct quotes\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3983\r\n* improvement:\ + \ python respects ir50, inserts defaults by @armandobelardo in https://github.com/fern-api/fern/pull/3982\r\ + \n* (fix, openapi): Prefer security schemes in order by @amckinney in https://github.com/fern-api/fern/pull/3984\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.10...0.31.11" + type: chore + createdAt: "2024-07-04" + irVersion: 50 + version: 0.31.11 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement: add advanced section to python readme\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3970\r\n* (feat):\ + \ customize status code for typescript express generator by @dsinghvi in https://github.com/fern-api/fern/pull/3971\r\ + \n* fix, python: allow offsets to start at 0 by @armandobelardo in https://github.com/fern-api/fern/pull/3972\r\ + \n* fix: python pagination helper types now share generic type by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3973\r\n* chore: update python seed\ + \ after generator-cli update by @armandobelardo in https://github.com/fern-api/fern/pull/3974\r\ + \n* (charp, fix): Empty Root Client Methods + `.Core` namespace issue by @dcb6\ + \ in https://github.com/fern-api/fern/pull/3975\r\n* (java, improvement): change\ + \ default `JsonInclude` behavior by @dcb6 in https://github.com/fern-api/fern/pull/3978\r\ + \n* (csharp, fix): base client requests not generated by @dcb6 in https://github.com/fern-api/fern/pull/3976\r\ + \n* chore: plumb through ruby snippets config to FDR by @armandobelardo in https://github.com/fern-api/fern/pull/3980\r\ + \n* improvement: allow boolean defaults within IR by @armandobelardo in https://github.com/fern-api/fern/pull/3981\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.9...0.31.10" + type: chore + createdAt: "2024-07-03" + irVersion: 50 + version: 0.31.10 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement: python async snippets now leverage\ + \ asyncio run by @armandobelardo in https://github.com/fern-api/fern/pull/3961\r\ + \n* improvement: allow adding extra dependencies to Ruby SDK by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3960\r\n* fix: Mark CSS files as\ + \ 'will not be uploaded' by @trevorblades in https://github.com/fern-api/fern/pull/3964\r\ + \n* (fix, cli): make sure `js` file checking works by @dsinghvi in https://github.com/fern-api/fern/pull/3963\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.8...0.31.9" + type: chore + createdAt: "2024-07-01" + irVersion: 49 + version: 0.31.9 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: generator upgrade cli upgrades in place\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3951\r\n* feat:\ + \ add reviewers blocks to generators.yml by @armandobelardo in https://github.com/fern-api/fern/pull/3952\r\ + \n* Use all FormData headers and don't stringify stream.Readable by @williamluer\ + \ in https://github.com/fern-api/fern/pull/3956\r\n* (feat, csharp): support\ + \ extra dependencies by @dsinghvi in https://github.com/fern-api/fern/pull/3957\r\ + \n* improvement: allow specifying if taking major in flag by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3958\r\n* fix: include css alongside\ + \ js when validating UTF8 files by @abvthecity in https://github.com/fern-api/fern/pull/3959\r\ + \n\r\n## New Contributors\r\n* @williamluer made their first contribution in\ + \ https://github.com/fern-api/fern/pull/3956\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.7...0.31.8" + type: chore + createdAt: "2024-07-01" + irVersion: 49 + version: 0.31.8 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: validate files to be uploaded by @trevorblades\ + \ in https://github.com/fern-api/fern/pull/3917\r\n* fix: python list allowlist\ + \ is now case insensitive by @armandobelardo in https://github.com/fern-api/fern/pull/3950\r\ + \n* improvement: add x-fern-base-path to asyncapi extensions by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3953\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.31.6...0.31.7" + type: chore + createdAt: "2024-06-28" + irVersion: 49 + version: 0.31.7 +- changelogEntry: + - summary: "## What's Changed\r\n* (improvement, typescript): support overriding\ + \ global headers by @dsinghvi in https://github.com/fern-api/fern/pull/3945\r\ + \n* feat, python: introduce `reference.md` generation by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3946\r\n* (fix, csharp): json serialize\ + \ enums before sending over the wire by @dsinghvi in https://github.com/fern-api/fern/pull/3947\r\ + \n* (fix, cli): remove out of range number validations in `openapi-ir-to-fern`\ + \ + remove husky by @dcb6 in https://github.com/fern-api/fern/pull/3948\r\n\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.5...0.31.6" + type: chore + createdAt: "2024-06-27" + irVersion: 49 + version: 0.31.6 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: api update command now works with unioned\ + \ + nested APIs by @armandobelardo in https://github.com/fern-api/fern/pull/3944\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.4...0.31.5" + type: chore + createdAt: "2024-06-27" + irVersion: 49 + version: 0.31.5 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat, typescript): support automatic cursor\ + \ based pagination by @dsinghvi in https://github.com/fern-api/fern/pull/3941\r\ + \n* (fix, typescript): auto pagination handles optional results arrays by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3942\r\n* (fix, openapi): `x-fern-global-headers`\ + \ works with predefined types by @dsinghvi in https://github.com/fern-api/fern/pull/3943\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.3...0.31.4" + type: chore + createdAt: "2024-06-27" + irVersion: 49 + version: 0.31.4 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: the python sdk sends additional properties\ + \ to the correct reques\u2026 by @armandobelardo in https://github.com/fern-api/fern/pull/3936\r\ + \n* java, improvement: improve java exception naming by @dcb6 in https://github.com/fern-api/fern/pull/3938\r\ + \n* Bump golang.org/x/tools from 0.21.0 to 0.22.0 in /generators/go by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3823\r\n* (fix): make sure that `exclusiveMaximum`\ + \ and `exclusiveMinimum` are always booleans by @dsinghvi in https://github.com/fern-api/fern/pull/3940\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.2...0.31.3" + type: chore + createdAt: "2024-06-26" + irVersion: 49 + version: 0.31.3 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): openapi parser gets boolean values safely\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3937\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.31.1...0.31.2" + type: chore + createdAt: "2024-06-26" + irVersion: 49 + version: 0.31.2 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: ruby RC respects header prefixes again by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3927\r\n* (feat,\ + \ cli): add support for `--mode pull-request` in the CLI when running `fern\ + \ generate` by @dsinghvi in https://github.com/fern-api/fern/pull/3928\r\n*\ + \ fix, ruby: add one missed prefix fix by @armandobelardo in https://github.com/fern-api/fern/pull/3929\r\ + \n* docs: add java example for oauth by @dcb6 in https://github.com/fern-api/fern/pull/3930\r\ + \n* (improvement, python): add in root client templates for python snippets\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3931\r\n* Update\ + \ generate-api-ref.mdx by @dannysheridan in https://github.com/fern-api/fern/pull/3933\r\ + \n* improvement: add streaming and pagination sections to generated readme by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3932\r\n* java: make\ + \ base api error class name configurable by @dcb6 in https://github.com/fern-api/fern/pull/3934\r\ + \n* (chore, internal): upgrade python generator to use ir v49 by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3915\r\n* build(deps-dev): bump @types/jest-specific-snapshot\ + \ from 0.5.7 to 0.5.9 by @dependabot in https://github.com/fern-api/fern/pull/3925\r\ + \n* build(deps-dev): bump jsonc-parser from 2.2.1 to 3.3.0 by @dependabot in\ + \ https://github.com/fern-api/fern/pull/3924\r\n* build(deps-dev): bump @types/is-ci\ + \ from 3.0.2 to 3.0.4 by @dependabot in https://github.com/fern-api/fern/pull/3922\r\ + \n* (fix, typescript): upgrade generators to `v46.2.0` by @dsinghvi in https://github.com/fern-api/fern/pull/3935\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.0...0.31.1" + type: chore + createdAt: "2024-06-26" + irVersion: 49 + version: 0.31.1 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.0-rc5...0.31.0" + type: chore + createdAt: "2024-06-24" + irVersion: 49 + version: 0.31.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): set when uploading a mock server definition\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3926\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.31.0-rc4...0.31.0-rc5" + type: chore + createdAt: "2024-06-24" + irVersion: 49 + version: 0.31.0-rc5 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat, IR): support streaming code generation\ + \ with the parameter by @dsinghvi in https://github.com/fern-api/fern/pull/3914\r\ + \n* (feat): update frontmatter docs by @chdeskur in https://github.com/fern-api/fern/pull/3916\r\ + \n* (fix, cli): examples dont print out where the missing property is by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3919\r\n* (fix): dont error if required\ + \ literal parameters are unspecified by @dsinghvi in https://github.com/fern-api/fern/pull/3921\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.0-rc3...0.31.0-rc4" + type: chore + createdAt: "2024-06-24" + irVersion: 49 + version: 0.31.0-rc4 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, python): SDK doesn't leak `JSONDecodeError`\ + \ to users by @dsinghvi in https://github.com/fern-api/fern/pull/3908\r\n* (fix,\ + \ python): python sdk generator handles stream termination like `[[DONE]]` by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/3909\r\n* (feature, readme):\ + \ Add support for configurable introduction by @amckinney in https://github.com/fern-api/fern/pull/3898\r\ + \n* build(deps): bump ws from 8.17.0 to 8.17.1 by @dependabot in https://github.com/fern-api/fern/pull/3866\r\ + \n* (internal, refactor): make `OSSWorkspace` and `FernWorkspace` classes by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/3910\r\n* (refactor, internal):\ + \ generate fern workspace before calling generate by @dsinghvi in https://github.com/fern-api/fern/pull/3911\r\ + \n* (refactor, internal): clean up how OpenAPI parser deals with settings by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/3912\r\n* (feat, cli):\ + \ support customizing api settings per generator by @dsinghvi in https://github.com/fern-api/fern/pull/3913\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.0-rc2...0.31.0-rc3" + type: chore + createdAt: "2024-06-24" + irVersion: 48 + version: 0.31.0-rc3 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, csharp): concatenate `baseURL` and endpoint\ + \ path together by @dsinghvi in https://github.com/fern-api/fern/pull/3906\r\ + \n* (fix, cli): literal examples are generated correctly in the IR by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3907\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.31.0-rc1...0.31.0-rc2" + type: chore + createdAt: "2024-06-22" + irVersion: 48 + version: 0.31.0-rc2 +- changelogEntry: + - summary: "## What's Changed\r\n* fix, ruby: leverage a types module by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3893\r\n* (fix, typescript): generate\ + \ streaming endpoint snippets by @dsinghvi in https://github.com/fern-api/fern/pull/3895\r\ + \n* fix: new ruby generator config matches class reference and class decl\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3896\r\n* fix,\ + \ python: readme is not specified in pyproject if not made by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3894\r\n* (fix, csharp): query params\ + \ for datetimes index `Value` by @dsinghvi in https://github.com/fern-api/fern/pull/3892\r\ + \n* (feature, python): Generate better README.md by @amckinney in https://github.com/fern-api/fern/pull/3897\r\ + \n* (fix, typescript): remove fs dependency in browser runtimes by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3899\r\n* (fix, csharp): sdk respects\ + \ service level path and path parameters by @dsinghvi in https://github.com/fern-api/fern/pull/3900\r\ + \n* fix: validate files to be uploaded by @trevorblades in https://github.com/fern-api/fern/pull/3872\r\ + \n* (feat, csharp): support sending bytes requests by @dsinghvi in https://github.com/fern-api/fern/pull/3901\r\ + \n* (fix, csharp): safe join url and base path by @dsinghvi in https://github.com/fern-api/fern/pull/3902\r\ + \n* Revert \"fix: validate files to be uploaded\" by @abvthecity in https://github.com/fern-api/fern/pull/3904\r\ + \n* feat: changelog on tabs and sections by @abvthecity in https://github.com/fern-api/fern/pull/3903\r\ + \n\r\n## New Contributors\r\n* @trevorblades made their first contribution in\ + \ https://github.com/fern-api/fern/pull/3872\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.31.0-rc0...0.31.0-rc1" + type: chore + createdAt: "2024-06-22" + irVersion: 48 + version: 0.31.0-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, csharp): revert to .NET 6+ compatibility\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3882\r\n* (fix, ts):\ + \ Fix environment import in snippets by @amckinney in https://github.com/fern-api/fern/pull/3885\r\ + \n* (feat, internal): setup csharp seed scripts by @dsinghvi in https://github.com/fern-api/fern/pull/3884\r\ + \n* (feature, ts): Merge README.md files by @amckinney in https://github.com/fern-api/fern/pull/3881\r\ + \n* (fix, csharp): ToString() Datetimes must be explicitly iso encoded by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3886\r\n* (feat, internal): run seed\ + \ with audiences by @dsinghvi in https://github.com/fern-api/fern/pull/3887\r\ + \n* (fix, csharp): handle discriminated unions + header literal parameters by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/3888\r\n* (fix, csharp):\ + \ handle optional datetime encoding by @dsinghvi in https://github.com/fern-api/fern/pull/3889\r\ + \n* (fix): add seed test case for optional datetime query parameters by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3890\r\n* (fix): remove sdk language\ + \ toggle for new unions by @dsinghvi in https://github.com/fern-api/fern/pull/3891\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.10...0.31.0-rc0" + type: chore + createdAt: "2024-06-20" + irVersion: 48 + version: 0.31.0-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore, python): Upgrade to IRv46 by @amckinney\ + \ in https://github.com/fern-api/fern/pull/3880\r\n* feat: add basepath to preview\ + \ generation by @abvthecity in https://github.com/fern-api/fern/pull/3877\r\n\ + \r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.9...0.30.10" + type: chore + createdAt: "2024-06-19" + irVersion: 48 + version: 0.30.10 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: bold text on \u201Ccomparison with openapi\u201D\ + \ docs by @zachkirsch in https://github.com/fern-api/fern/pull/3876\r\n* (fix,\ + \ typescript): snippet templates include client import by @dsinghvi in https://github.com/fern-api/fern/pull/3878\r\ + \n* (fix, ts): Update README.md snippets to call nested methods by @amckinney\ + \ in https://github.com/fern-api/fern/pull/3873\r\n* fix: python and ts generators\ + \ only add publish block if they have cre\u2026 by @armandobelardo in https://github.com/fern-api/fern/pull/3871\r\ + \n* (fix, openapi): generate examples for discriminated unions by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3879\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.30.8...0.30.9" + type: chore + createdAt: "2024-06-19" + irVersion: 48 + version: 0.30.9 +- changelogEntry: + - summary: + "## What's Changed\r\n* java, feature: pagination by @dcb6 in https://github.com/fern-api/fern/pull/3845\r\ + \n* (fix): handle code samples without accompanying examples by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3849\r\n* (fix, ts): Add environment\ + \ property to snippets by @amckinney in https://github.com/fern-api/fern/pull/3850\r\ + \n* feat: api navigation reorder by @abvthecity in https://github.com/fern-api/fern/pull/3841\r\ + \n* (fix, webhooks): support audiences for webhooks and payload properties by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/3851\r\n* fix: merge and\ + \ filter children within non-visited subpackage by @abvthecity in https://github.com/fern-api/fern/pull/3854\r\ + \n* (fix, docs): Update OAuth section by @amckinney in https://github.com/fern-api/fern/pull/3856\r\ + \n* build(deps): bump idna from 3.6 to 3.7 in /generators/python by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3364\r\n* (fix, ts): Snippets and\ + \ GitHub publish workflow by @amckinney in https://github.com/fern-api/fern/pull/3858\r\ + \n* docs: fix broken links to cli commands by @atwooddc in https://github.com/fern-api/fern/pull/3782\r\ + \n* docs: add openapi and asyncapi overrides by @dannysheridan in https://github.com/fern-api/fern/pull/3863\r\ + \n* build(deps): bump @fern-fern/ir-v1-model from 0.0.1 to 0.0.2 by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3861\r\n* build(deps): bump @fern-fern/ir-v16-model\ + \ from 0.0.1 to 0.0.4 by @dependabot in https://github.com/fern-api/fern/pull/3860\r\ + \n* feat, ruby: enable oauth client generation by @armandobelardo in https://github.com/fern-api/fern/pull/3842\r\ + \n* docs: add fern definition display-name property by @chdeskur in https://github.com/fern-api/fern/pull/3864\r\ + \n* (feature, IRv48): Add offset pagination step by @amckinney in https://github.com/fern-api/fern/pull/3865\r\ + \n* bump ir to account for ruby upgrade by @armandobelardo in https://github.com/fern-api/fern/pull/3868\r\ + \n* [FER-1985] Adds support for templatized Client Generation parameters in\ + \ Dynamic Snippets by @ppod1991 in https://github.com/fern-api/fern/pull/3848\r\ + \n* fix, ruby: deeply nested from_json functions now respect whether to call\ + \ to_json or not by @armandobelardo in https://github.com/fern-api/fern/pull/3870\r\ + \n* fix: subpackages should recursively expand its children by @abvthecity in\ + \ https://github.com/fern-api/fern/pull/3875\r\n* docs: update how to specify\ + \ servers with FastAPI by @minaelee in https://github.com/fern-api/fern/pull/3874\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.7...0.30.8" + type: chore + createdAt: "2024-06-18" + irVersion: 48 + version: 0.30.8 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: merge and filter children within non-visited\ + \ subpackage by @abvthecity in https://github.com/fern-api/fern/pull/3854\r\n\ + * (fix, docs): Update OAuth section by @amckinney in https://github.com/fern-api/fern/pull/3856\r\ + \n* build(deps): bump idna from 3.6 to 3.7 in /generators/python by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3364\r\n* (fix, ts): Snippets and\ + \ GitHub publish workflow by @amckinney in https://github.com/fern-api/fern/pull/3858\r\ + \n* docs: fix broken links to cli commands by @atwooddc in https://github.com/fern-api/fern/pull/3782\r\ + \n* docs: add openapi and asyncapi overrides by @dannysheridan in https://github.com/fern-api/fern/pull/3863\r\ + \n* build(deps): bump @fern-fern/ir-v1-model from 0.0.1 to 0.0.2 by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3861\r\n* build(deps): bump @fern-fern/ir-v16-model\ + \ from 0.0.1 to 0.0.4 by @dependabot in https://github.com/fern-api/fern/pull/3860\r\ + \n* feat, ruby: enable oauth client generation by @armandobelardo in https://github.com/fern-api/fern/pull/3842\r\ + \n* docs: add fern definition display-name property by @chdeskur in https://github.com/fern-api/fern/pull/3864\r\ + \n* (feature, IRv48): Add offset pagination step by @amckinney in https://github.com/fern-api/fern/pull/3865\r\ + \n* bump ir to account for ruby upgrade by @armandobelardo in https://github.com/fern-api/fern/pull/3868\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.8-rc6...0.30.8-rc7" + type: chore + createdAt: "2024-06-18" + irVersion: 48 + version: 0.30.8-rc7 +- changelogEntry: + - summary: "## What's Changed\r\n* feat: api navigation reorder by @abvthecity in\ + \ https://github.com/fern-api/fern/pull/3841\r\n* (fix, webhooks): support audiences\ + \ for webhooks and payload properties by @dsinghvi in https://github.com/fern-api/fern/pull/3851\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.8-rc2...0.30.8-rc6" + type: chore + createdAt: "2024-06-14" + irVersion: 47 + version: 0.30.8-rc6 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.8-rc4...0.30.8-rc5" + type: chore + createdAt: "2024-06-14" + irVersion: 47 + version: 0.30.8-rc5 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.8-rc3...0.30.8-rc4" + type: chore + createdAt: "2024-06-14" + irVersion: 47 + version: 0.30.8-rc4 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): handle code samples without accompanying\ + \ examples by @dsinghvi in https://github.com/fern-api/fern/pull/3849\r\n* (fix,\ + \ ts): Add environment property to snippets by @amckinney in https://github.com/fern-api/fern/pull/3850\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.8-rc1...0.30.8-rc3" + type: chore + createdAt: "2024-06-14" + irVersion: 47 + version: 0.30.8-rc3 +- changelogEntry: + - summary: + "## What's Changed\r\n* java, feature: pagination by @dcb6 in https://github.com/fern-api/fern/pull/3845\r\ + \n* (fix): handle code samples without accompanying examples by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3849\r\n* (fix, ts): Add environment\ + \ property to snippets by @amckinney in https://github.com/fern-api/fern/pull/3850\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.7...0.30.8-rc2" + type: chore + createdAt: "2024-06-14" + irVersion: 47 + version: 0.30.8-rc2 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.8-rc0...0.30.8-rc1" + type: chore + createdAt: "2024-06-14" + irVersion: 46 + version: 0.30.8-rc1 +- changelogEntry: + - summary: + "## What's Changed\r\n* java, feature: pagination by @dcb6 in https://github.com/fern-api/fern/pull/3845\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.7...0.30.8-rc0" + type: chore + createdAt: "2024-06-14" + irVersion: 46 + version: 0.30.8-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: after parsing the paths, replace the image\ + \ paths with file ids by @abvthecity in https://github.com/fern-api/fern/pull/3847\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.6...0.30.7" + type: chore + createdAt: "2024-06-13" + irVersion: 46 + version: 0.30.7 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature, openapi): Add better support for OpenAPI\ + \ webhooks by @amckinney in https://github.com/fern-api/fern/pull/3846\r\n\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.5...0.30.6" + type: chore + createdAt: "2024-06-13" + irVersion: 46 + version: 0.30.6 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, go): Handle deepObject query parameter\ + \ arrays by @amckinney in https://github.com/fern-api/fern/pull/3836\r\n* [FER-1986]\ + \ Fix two DiscriminatedUnion bugs in dynamic Typescript snippets by @ppod1991\ + \ in https://github.com/fern-api/fern/pull/3833\r\n* added custom package json\ + \ config by @jmedway614 in https://github.com/fern-api/fern/pull/3832\r\n* (release,\ + \ typescript): version `0.23.0-rc1` by @dsinghvi in https://github.com/fern-api/fern/pull/3838\r\ + \n* (fix, ts): Support README.md generation in local mode by @amckinney in https://github.com/fern-api/fern/pull/3839\r\ + \n* Chdeskur/streamline audiences by @chdeskur in https://github.com/fern-api/fern/pull/3815\r\ + \n* Bump boxen from 7.0.0 to 7.1.1 by @dependabot in https://github.com/fern-api/fern/pull/3827\r\ + \n* Bump inquirer and @types/inquirer by @dependabot in https://github.com/fern-api/fern/pull/3828\r\ + \n* Bump braces from 3.0.2 to 3.0.3 by @dependabot in https://github.com/fern-api/fern/pull/3837\r\ + \n* Bump github.com/fern-api/generator-exec-go from 0.0.874 to 0.0.877 in /generators/go\ + \ by @dependabot in https://github.com/fern-api/fern/pull/3825\r\n* Bump golang.org/x/mod\ + \ from 0.17.0 to 0.18.0 in /generators/go by @dependabot in https://github.com/fern-api/fern/pull/3824\r\ + \n* integration docs by @chdeskur in https://github.com/fern-api/fern/pull/3795\r\ + \n* fix, python: the unchecked base model stops special casing pydantic v2 by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3840\r\n* (fix, ts):\ + \ Handle undiscriminated union map key examples by @amckinney in https://github.com/fern-api/fern/pull/3844\r\ + \n* java: upgrade to IR 46 + BigInteger support by @dcb6 in https://github.com/fern-api/fern/pull/3814\r\ + \n* fix: image path parsing from markdown considers MDX children by @abvthecity\ + \ in https://github.com/fern-api/fern/pull/3843\r\n\r\n## New Contributors\r\ + \n* @ppod1991 made their first contribution in https://github.com/fern-api/fern/pull/3833\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.4...0.30.5" + type: chore + createdAt: "2024-06-13" + irVersion: 46 + version: 0.30.5 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: pagination is 1-based not 0 by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3835\r\n* (fix, openapi): fall back\ + \ to default status code if none provided by @dsinghvi in https://github.com/fern-api/fern/pull/3834\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.3...0.30.4" + type: chore + createdAt: "2024-06-11" + irVersion: 46 + version: 0.30.4 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature, ts): Add generator-cli client to generate\ + \ README.md by @amckinney in https://github.com/fern-api/fern/pull/3817\r\n\ + * (fix, python): Unions with single element and/or no properties by @amckinney\ + \ in https://github.com/fern-api/fern/pull/3822\r\n* (fix, openapi): Handle\ + \ more `allow-multiple` oneOf cases by @amckinney in https://github.com/fern-api/fern/pull/3830\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.2...0.30.3" + type: chore + createdAt: "2024-06-10" + irVersion: 46 + version: 0.30.3 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): snippet templates for discriminated unions\ + \ specify `template_inputs` by @dsinghvi in https://github.com/fern-api/fern/pull/3808\r\ + \n* fix python seed by @dsinghvi in https://github.com/fern-api/fern/pull/3809\r\ + \n* (feature): Write ReameConfig in IR by @amckinney in https://github.com/fern-api/fern/pull/3786\r\ + \n* python: improve seed setup script by @dcb6 in https://github.com/fern-api/fern/pull/3810\r\ + \n* (fix): fern definition overview repetition by @chdeskur in https://github.com/fern-api/fern/pull/3812\r\ + \n* fix: unchecked base model respects dicts as well as objects by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3813\r\n* (feat): C# is `.NET 4`\ + \ compatible by @dsinghvi in https://github.com/fern-api/fern/pull/3816\r\n\ + * add query encoder tests for value and for None by @jmedway614 in https://github.com/fern-api/fern/pull/3818\r\ + \n* (internal, python): python generator uses python 3.9 and pins mypy by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3819\r\n* (internal, ir-sdk): generate\ + \ ir sdk with pydantic v1 by @dsinghvi in https://github.com/fern-api/fern/pull/3820\r\ + \n* (chore, ts): Pin IRv46 TypeScript migrator versions by @amckinney in https://github.com/fern-api/fern/pull/3821\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.1...0.30.2" + type: chore + createdAt: "2024-06-10" + irVersion: 46 + version: 0.30.2 +- changelogEntry: + - summary: "## What's Changed\r\n* fix, python: update timeout parameter docs by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3771\r\n* fix, python:\ + \ mypy variance check by @armandobelardo in https://github.com/fern-api/fern/pull/3772\r\ + \n* java: make sure oauth gated properly by @dcb6 in https://github.com/fern-api/fern/pull/3757\r\ + \n* Bump validate-npm-package-name from 4.0.0 to 5.0.1 by @dependabot in https://github.com/fern-api/fern/pull/3765\r\ + \n* Bump jwks-rsa from 3.0.0 to 3.1.0 by @dependabot in https://github.com/fern-api/fern/pull/3767\r\ + \n* clean up step text by @chdeskur in https://github.com/fern-api/fern/pull/3774\r\ + \n* Bump qs and @types/qs by @dependabot in https://github.com/fern-api/fern/pull/3768\r\ + \n* feat: skip-slug in tabs by @abvthecity in https://github.com/fern-api/fern/pull/3780\r\ + \n* (docs): Add Go and Ruby snippet sections by @amckinney in https://github.com/fern-api/fern/pull/3775\r\ + \n* (feature): Add ReadmeConfig IR and generators.yml schema by @amckinney in\ + \ https://github.com/fern-api/fern/pull/3781\r\n* improvement, python: unit\ + \ tests are now run in CI if configured by @armandobelardo in https://github.com/fern-api/fern/pull/3783\r\ + \n* java, improvement: error types by @dcb6 in https://github.com/fern-api/fern/pull/3779\r\ + \n* java, feat: support response properties in sdk by @dcb6 in https://github.com/fern-api/fern/pull/3785\r\ + \n* fix, python: the new client ensures there's a slash on the base path by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3787\r\n* (fix, python):\ + \ generated python snippets respect trailing slashes by @dsinghvi in https://github.com/fern-api/fern/pull/3789\r\ + \n* (chore, ts): Upgrade to IRv46 by @amckinney in https://github.com/fern-api/fern/pull/3788\r\ + \n* (feat): run mypy on non integration tests by @dsinghvi in https://github.com/fern-api/fern/pull/3794\r\ + \n* fix, python: regressions with client clean up by @armandobelardo in https://github.com/fern-api/fern/pull/3797\r\ + \n* fix: address a number of unit test issues by @armandobelardo in https://github.com/fern-api/fern/pull/3800\r\ + \n* java, fix: use `@java.lang.Override` in all generated code by @dcb6 in https://github.com/fern-api/fern/pull/3799\r\ + \n* (eslint): check for `no-misused-promises` by @dsinghvi in https://github.com/fern-api/fern/pull/3801\r\ + \n* upgrade: fdr-sdk by @abvthecity in https://github.com/fern-api/fern/pull/3792\r\ + \n* improvement: add local configuration for python by @armandobelardo in https://github.com/fern-api/fern/pull/3803\r\ + \n* (fix): Publish ir-types-latest by @amckinney in https://github.com/fern-api/fern/pull/3806\r\ + \n* Add Extra Field Support for FastAPI by @jmedway614 in https://github.com/fern-api/fern/pull/3804\r\ + \n* java, fix: initialize `RequestOptions` `timeout` field correctly to `Optional.empty()`\ + \ by @dcb6 in https://github.com/fern-api/fern/pull/3807\r\n* (fix, typescript):\ + \ prefer `TextDecoder` when deserializing stream data by @dsinghvi in https://github.com/fern-api/fern/pull/3791\r\ + \n\r\n## New Contributors\r\n* @jmedway614 made their first contribution in\ + \ https://github.com/fern-api/fern/pull/3804\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.0...0.30.1" + type: chore + createdAt: "2024-06-07" + irVersion: 46 + version: 0.30.1 +- changelogEntry: + - summary: "## What's Changed\r\n* fix, python: update timeout parameter docs by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3771\r\n* fix, python:\ + \ mypy variance check by @armandobelardo in https://github.com/fern-api/fern/pull/3772\r\ + \n* java: make sure oauth gated properly by @dcb6 in https://github.com/fern-api/fern/pull/3757\r\ + \n* Bump validate-npm-package-name from 4.0.0 to 5.0.1 by @dependabot in https://github.com/fern-api/fern/pull/3765\r\ + \n* Bump jwks-rsa from 3.0.0 to 3.1.0 by @dependabot in https://github.com/fern-api/fern/pull/3767\r\ + \n* clean up step text by @chdeskur in https://github.com/fern-api/fern/pull/3774\r\ + \n* Bump qs and @types/qs by @dependabot in https://github.com/fern-api/fern/pull/3768\r\ + \n* feat: skip-slug in tabs by @abvthecity in https://github.com/fern-api/fern/pull/3780\r\ + \n* (docs): Add Go and Ruby snippet sections by @amckinney in https://github.com/fern-api/fern/pull/3775\r\ + \n* (feature): Add ReadmeConfig IR and generators.yml schema by @amckinney in\ + \ https://github.com/fern-api/fern/pull/3781\r\n* improvement, python: unit\ + \ tests are now run in CI if configured by @armandobelardo in https://github.com/fern-api/fern/pull/3783\r\ + \n* java, improvement: error types by @dcb6 in https://github.com/fern-api/fern/pull/3779\r\ + \n* java, feat: support response properties in sdk by @dcb6 in https://github.com/fern-api/fern/pull/3785\r\ + \n* fix, python: the new client ensures there's a slash on the base path by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3787\r\n* (fix, python):\ + \ generated python snippets respect trailing slashes by @dsinghvi in https://github.com/fern-api/fern/pull/3789\r\ + \n* (chore, ts): Upgrade to IRv46 by @amckinney in https://github.com/fern-api/fern/pull/3788\r\ + \n* (feat): run mypy on non integration tests by @dsinghvi in https://github.com/fern-api/fern/pull/3794\r\ + \n* fix, python: regressions with client clean up by @armandobelardo in https://github.com/fern-api/fern/pull/3797\r\ + \n* fix: address a number of unit test issues by @armandobelardo in https://github.com/fern-api/fern/pull/3800\r\ + \n* java, fix: use `@java.lang.Override` in all generated code by @dcb6 in https://github.com/fern-api/fern/pull/3799\r\ + \n* (eslint): check for `no-misused-promises` by @dsinghvi in https://github.com/fern-api/fern/pull/3801\r\ + \n* upgrade: fdr-sdk by @abvthecity in https://github.com/fern-api/fern/pull/3792\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.30.0...0.30.1-rc1" + type: chore + createdAt: "2024-06-06" + irVersion: 46 + version: 0.30.1-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: address a number of papercuts in the mock\ + \ server and python unit tests by @armandobelardo in https://github.com/fern-api/fern/pull/3749\r\ + \n* (fix, ts): Simplify OAuth error handling by @amckinney in https://github.com/fern-api/fern/pull/3752\r\ + \n* docs: add java examples by @dcb6 in https://github.com/fern-api/fern/pull/3755\r\ + \n* (feat, python): write out example ids in generated snippets by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3750\r\n* docs: remove maxHeight\ + \ prop by @chdeskur in https://github.com/fern-api/fern/pull/3734\r\n* (fix,\ + \ typescript): peer dependencies are always persisted by @dsinghvi in https://github.com/fern-api/fern/pull/3758\r\ + \n* docs: added custom css & js page by @atwooddc in https://github.com/fern-api/fern/pull/3753\r\ + \n* (fix, typescript): example identifiers are added to generated snippets by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/3759\r\n* improvement,\ + \ python: clean up endpoint functions by centralizing logic by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3761\r\n* improvement: add literal\ + \ example type and add id to example by @armandobelardo in https://github.com/fern-api/fern/pull/3756\r\ + \n* improvement: filter out nulls after merging API specs by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3710\r\n* (docs): Add discriminated\ + \ union section by @amckinney in https://github.com/fern-api/fern/pull/3763\r\ + \n* improvement: add a flag to allow python to generate discriminated unions\ + \ as undiscriminated unions by @armandobelardo in https://github.com/fern-api/fern/pull/3740\r\ + \n* (feature): Add keywords configuration by @amckinney in https://github.com/fern-api/fern/pull/3769\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.29.5...0.30.0" + type: chore + createdAt: "2024-06-03" + irVersion: 46 + version: 0.30.0 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: address a number of papercuts in the mock\ + \ server and python unit tests by @armandobelardo in https://github.com/fern-api/fern/pull/3749\r\ + \n* (fix, ts): Simplify OAuth error handling by @amckinney in https://github.com/fern-api/fern/pull/3752\r\ + \n* docs: add java examples by @dcb6 in https://github.com/fern-api/fern/pull/3755\r\ + \n* (feat, python): write out example ids in generated snippets by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3750\r\n* docs: remove maxHeight\ + \ prop by @chdeskur in https://github.com/fern-api/fern/pull/3734\r\n* (fix,\ + \ typescript): peer dependencies are always persisted by @dsinghvi in https://github.com/fern-api/fern/pull/3758\r\ + \n* docs: added custom css & js page by @atwooddc in https://github.com/fern-api/fern/pull/3753\r\ + \n* (fix, typescript): example identifiers are added to generated snippets by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/3759\r\n* improvement,\ + \ python: clean up endpoint functions by centralizing logic by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3761\r\n* improvement: add literal\ + \ example type and add id to example by @armandobelardo in https://github.com/fern-api/fern/pull/3756\r\ + \n* improvement: filter out nulls after merging API specs by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3710\r\n* (docs): Add discriminated\ + \ union section by @amckinney in https://github.com/fern-api/fern/pull/3763\r\ + \n* improvement: add a flag to allow python to generate discriminated unions\ + \ as undiscriminated unions by @armandobelardo in https://github.com/fern-api/fern/pull/3740\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.29.5...0.30.0-rc0" + type: chore + createdAt: "2024-06-03" + irVersion: 46 + version: 0.30.0-rc0 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.29.5...0.29.6" + type: chore + createdAt: "2024-05-31" + irVersion: 45 + version: 0.29.6 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, ts): Throw an error upon OAuth refresh\ + \ failure by @amckinney in https://github.com/fern-api/fern/pull/3737\r\n* (fix,\ + \ openapi): Preserve descriptions in anyOf by @amckinney in https://github.com/fern-api/fern/pull/3748\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.29.4...0.29.5" + type: chore + createdAt: "2024-05-31" + irVersion: 45 + version: 0.29.5 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, typescript): disable integration test generation\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3731\r\n* (fix, typescript):\ + \ generated GitHub workflows do not assume `fern` present by @dsinghvi in https://github.com/fern-api/fern/pull/3732\r\ + \n* fix, python: add type annotations to test vars by @armandobelardo in https://github.com/fern-api/fern/pull/3733\r\ + \n* (feature, typescript): support `extraPeerDependencies` and `extraPeerDependenciesMeta`\ + \ in custom config by @dsinghvi in https://github.com/fern-api/fern/pull/3739\r\ + \n* docs: add note on GFM support by @chdeskur in https://github.com/fern-api/fern/pull/3738\r\ + \n* Bump eslint-plugin-jest from 27.0.4 to 27.9.0 by @dependabot in https://github.com/fern-api/fern/pull/3539\r\ + \n* Bump golang.org/x/tools from 0.20.0 to 0.21.0 in /generators/go by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3538\r\n* (feat, python): support\ + \ optional python deps + extras by @dsinghvi in https://github.com/fern-api/fern/pull/3742\r\ + \n* java, improvement: run seed faster using local mode by @dcb6 in https://github.com/fern-api/fern/pull/3741\r\ + \n* java, fix: generate builders even when types have no fields by @dcb6 in\ + \ https://github.com/fern-api/fern/pull/3744\r\n* (fix, csharp): support `List`\ + \ deserialization by @dsinghvi in https://github.com/fern-api/fern/pull/3745\r\ + \n* (feat, openapi): add support for `x-fern-idempotency-headers` by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3746\r\n\r\n## New Contributors\r\ + \n* @chdeskur made their first contribution in https://github.com/fern-api/fern/pull/3738\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.29.3...0.29.4" + type: chore + createdAt: "2024-05-31" + irVersion: 45 + version: 0.29.4 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): write mock definition by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3730\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.29.2...0.29.3" + type: chore + createdAt: "2024-05-30" + irVersion: 45 + version: 0.29.3 +- changelogEntry: + - summary: "## What's Changed\r\n* docs: fix broken links and anchor text by @atwooddc\ + \ in https://github.com/fern-api/fern/pull/3718\r\n* docs: nested tabs auto\ + \ pagination page bug by @atwooddc in https://github.com/fern-api/fern/pull/3717\r\ + \n* (fix, internal): do deploys of fern docs to dev by @dsinghvi in https://github.com/fern-api/fern/pull/3529\r\ + \n* fix, python: flatten optional pagination return types by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3721\r\n* java, fix: de-conflict\ + \ undiscriminated unions by @dcb6 in https://github.com/fern-api/fern/pull/3719\r\ + \n* improvement, python: literal fields are now defaulted by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3724\r\n* (fix, csharp): enum deserialization\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3725\r\n* docs:\ + \ added subtitle documentation on frontmatter page by @atwooddc in https://github.com/fern-api/fern/pull/3723\r\ + \n* docs: added api reference summary by @atwooddc in https://github.com/fern-api/fern/pull/3716\r\ + \n* docs: fixed broken links and updated openapi generator info by @atwooddc\ + \ in https://github.com/fern-api/fern/pull/3700\r\n* (fix, seed): Fix snapshots\ + \ by @dcb6 in https://github.com/fern-api/fern/pull/3726\r\n* (fix, csharp):\ + \ streamline enum + union serde by @dsinghvi in https://github.com/fern-api/fern/pull/3727\r\ + \n* (fix, typescript): remove `node:stream` import to play nicely with webpack\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3728\r\n* (fix, ts):\ + \ Support OAuth for SDKs that set neverThrowErrors by @amckinney in https://github.com/fern-api/fern/pull/3729\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.29.1...0.29.2" + type: chore + createdAt: "2024-05-29" + irVersion: 45 + version: 0.29.2 +- changelogEntry: + - summary: "## What's Changed\r\n* fix, python: do not manually specify custom license\ + \ file by @armandobelardo in https://github.com/fern-api/fern/pull/3697\r\n\ + * build(deps): bump github.com/fern-api/generator-exec-go from 0.0.817 to 0.0.823\ + \ in /generators/go by @dependabot in https://github.com/fern-api/fern/pull/3653\r\ + \n* fix, fastapi: fixes path prefixes and construction by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3699\r\n* (docs) Add Building Your Docs\ + \ section by @dannysheridan in https://github.com/fern-api/fern/pull/3698\r\n\ + * docs: individualized title tags by @atwooddc in https://github.com/fern-api/fern/pull/3704\r\ + \n* docs: add img alt attributes by @atwooddc in https://github.com/fern-api/fern/pull/3703\r\ + \n* docs fixed tabs meta description typo by @atwooddc in https://github.com/fern-api/fern/pull/3702\r\ + \n* (docs) Add custom subdomain and subpath instructions by @dannysheridan in\ + \ https://github.com/fern-api/fern/pull/3705\r\n* (fix, docs): add missing dashes\ + \ for \u201C--instance\u201D in CLI docs by @zachkirsch in https://github.com/fern-api/fern/pull/3709\r\ + \n* build(deps): bump github.com/fern-api/generator-exec-go from 0.0.823 to\ + \ 0.0.874 in /generators/go by @dependabot in https://github.com/fern-api/fern/pull/3707\r\ + \n* fix: ruby snippets now respect the full module path of the function call\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3706\r\n* (fix,\ + \ csharp): make C# sdk .NET 6 compatible by @dsinghvi in https://github.com/fern-api/fern/pull/3711\r\ + \n* (fix, csharp): generated GitHub workflows use `.NET` 8.x by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3712\r\n* fix: fastapi now has all pydantic\ + \ utilities it needs by @armandobelardo in https://github.com/fern-api/fern/pull/3713\r\ + \n* fix, python: add typing lib for dateutils by @armandobelardo in https://github.com/fern-api/fern/pull/3714\r\ + \n* Docs remove redirect links by @atwooddc in https://github.com/fern-api/fern/pull/3701\r\ + \n* (fix): `x-fern-base-path` impacts endpoint paths instead of `api.yml` base\ + \ path by @dsinghvi in https://github.com/fern-api/fern/pull/3720\r\n\r\n\r\n\ + **Full Changelog**: https://github.com/fern-api/fern/compare/0.29.1-rc0...0.29.2" + type: chore + createdAt: "2024-05-28" + irVersion: 45 + version: 0.29.1 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat, csharp): generate `Environments.cs` and\ + \ populate default `BaseURL` by @dsinghvi in https://github.com/fern-api/fern/pull/3677\r\ + \n* (fix, csharp): package in LICENSE in `.csproj` by @dsinghvi in https://github.com/fern-api/fern/pull/3678\r\ + \n* (fix, python): re-add python unit tests by @armandobelardo in https://github.com/fern-api/fern/pull/3609\r\ + \n* (chore, python): fix typo in generated comments by @armandobelardo in https://github.com/fern-api/fern/pull/3680\r\ + \n* fix, python: do not run `fern test` in CI yet by @armandobelardo in https://github.com/fern-api/fern/pull/3683\r\ + \n* docs changed trivial anchor text by @atwooddc in https://github.com/fern-api/fern/pull/3687\r\ + \n* docs: unbolded sections for seo by @atwooddc in https://github.com/fern-api/fern/pull/3686\r\ + \n* docs: api definition docs and mdx descriptions for seo by @atwooddc in https://github.com/fern-api/fern/pull/3685\r\ + \n* (fix, csharp): scan `EnumMember` annotations when serializaing to string\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3688\r\n* fix, python:\ + \ request bodies respect literals again by @armandobelardo in https://github.com/fern-api/fern/pull/3689\r\ + \n* (fix, python): support endpoint method names by @dsinghvi in https://github.com/fern-api/fern/pull/3690\r\ + \n* (fix, csharp): inlined requests that are 1:1 with HTTP bodies now have JSON\ + \ annotations by @dsinghvi in https://github.com/fern-api/fern/pull/3691\r\n\ + * docs cli UI changed to Accordion Group by @atwooddc in https://github.com/fern-api/fern/pull/3681\r\ + \n* docs: fixing broken links by @atwooddc in https://github.com/fern-api/fern/pull/3667\r\ + \n* Update extensions.mdx by @dannysheridan in https://github.com/fern-api/fern/pull/3658\r\ + \n* feat: markdown-in-markdown - load markdown from another markdown file. by\ + \ @abvthecity in https://github.com/fern-api/fern/pull/3693\r\n* java: oauth\ + \ improvements including token refresh by @dcb6 in https://github.com/fern-api/fern/pull/3682\r\ + \n* (feat, typescript): accept abort signals as request options by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3694\r\n* (fix, typescript): pass\ + \ abort signal to SSE/JSON streams by @dsinghvi in https://github.com/fern-api/fern/pull/3695\r\ + \n* (feat, express): pass `next` into express handlers by @dsinghvi in https://github.com/fern-api/fern/pull/3696\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.29.0...0.29.1-rc0" + type: chore + createdAt: "2024-05-24" + irVersion: 45 + version: 0.29.1-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, python): fix naming conflicts with inlined\ + \ body parameters by @armandobelardo in https://github.com/fern-api/fern/pull/3673\r\ + \n* (fix, python): correct snippets for optional referenced requests when\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3676\r\n* fix,\ + \ java: make java compatible with java 8 by @dcb6 in https://github.com/fern-api/fern/pull/3671\r\ + \n* (fix, python): use safe names wherever there's no string concat by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3674\r\n* (feature, openapi): Map\ + \ additionalProperties to extra-properties by @amckinney in https://github.com/fern-api/fern/pull/3675\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.28.0...0.29.0" + type: chore + createdAt: "2024-05-22" + irVersion: 45 + version: 0.29.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature): Add support for default values and\ + \ validation rules by @amckinney in https://github.com/fern-api/fern/pull/3640\r\ + \n* improvement: add in config to enrich pypi metadata by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3660\r\n* (fix, chsarp): `.csproj` generation\ + \ includes license, version, and github url by @dsinghvi in https://github.com/fern-api/fern/pull/3659\r\ + \n* feat: allow users to configure pypi details by @armandobelardo in https://github.com/fern-api/fern/pull/3662\r\ + \n* (fix, python): include project URLs in generated pyproject toml by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3663\r\n* (fix, python): change author\ + \ format and fix query encoder by @armandobelardo in https://github.com/fern-api/fern/pull/3664\r\ + \n* chore: update docs on using overrides.yml by @armandobelardo in https://github.com/fern-api/fern/pull/3666\r\ + \n* (feature, ts): Add inlineFileProperties configuration by @amckinney in https://github.com/fern-api/fern/pull/3661\r\ + \n* (chore, readme): add csharp sdk generator by @dannysheridan in https://github.com/fern-api/fern/pull/3665\r\ + \n* docs fixed typos by @atwooddc in https://github.com/fern-api/fern/pull/3668\r\ + \n* (feature, go): Expose extra response properties by @amckinney in https://github.com/fern-api/fern/pull/3669\r\ + \n* (feature): Add SAML and SSO to common initialisms by @amckinney in https://github.com/fern-api/fern/pull/3670\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.27.0...0.28.0" + type: chore + createdAt: "2024-05-21" + irVersion: 45 + version: 0.28.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature): Add support for default values and\ + \ validation rules by @amckinney in https://github.com/fern-api/fern/pull/3640\r\ + \n* improvement: add in config to enrich pypi metadata by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3660\r\n* (fix, chsarp): `.csproj` generation\ + \ includes license, version, and github url by @dsinghvi in https://github.com/fern-api/fern/pull/3659\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.27.0...0.27.1-rc0" + type: chore + createdAt: "2024-05-21" + irVersion: 45 + version: 0.27.1-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n- (feature): support local preview of docs via\ + \ `fern docs dev`\r\n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.11...0.27.0" + type: chore + createdAt: "2024-05-20" + irVersion: 45 + version: 0.27.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat, docs): document local previews by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3649\r\n* chore: add identifier override\ + \ to further specify snippets by @armandobelardo in https://github.com/fern-api/fern/pull/3642\r\ + \n* fixed broken internal links on docs site by @atwooddc in https://github.com/fern-api/fern/pull/3656\r\ + \n* chore: add v1 websocket events in local docs preview by @abvthecity in https://github.com/fern-api/fern/pull/3655\r\ + \n* fix, python: deconflict parameter names when inlining request parameters\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3650\r\n* (fix):\ + \ support running docs dev server on a port by @dsinghvi in https://github.com/fern-api/fern/pull/3657\r\ + \n\r\n## New Contributors\r\n* @atwooddc made their first contribution in https://github.com/fern-api/fern/pull/3656\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.10...0.26.11" + type: chore + createdAt: "2024-05-20" + irVersion: 45 + version: 0.26.11 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): `fern docs preview` -> `fern docs dev`\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3647\r\n* (fix): docs\ + \ preview server is fault tolerant to invalid `docs.yml` files by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3648\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.26.10-rc2...0.26.10" + type: chore + createdAt: "2024-05-19" + irVersion: 45 + version: 0.26.10 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): improve local preview responsiveness by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/3646\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.26.10-rc1...0.26.10-rc2" + type: chore + createdAt: "2024-05-19" + irVersion: 45 + version: 0.26.10-rc2 +- changelogEntry: + - summary: "## What's Changed\r\n* chore: document auto-pagination configuration\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3644\r\n* Tidy\ + \ up python generator docs by @fabubaker in https://github.com/fern-api/fern/pull/3645\r\ + \n* (feat, local preview): setup dynamic local preview by @dsinghvi in https://github.com/fern-api/fern/pull/3634\r\ + \n* refactor: share common logic between publishDocs and previewDocs by @abvthecity\ + \ in https://github.com/fern-api/fern/pull/3639\r\n\r\n## New Contributors\r\ + \n* @fabubaker made their first contribution in https://github.com/fern-api/fern/pull/3645\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.10-rc0...0.26.10-rc1" + type: chore + createdAt: "2024-05-19" + irVersion: 45 + version: 0.26.10-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* chore: clean up some nuget references by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3627\r\n* (fix, ts): OAuth provides\ + \ an optional token by @amckinney in https://github.com/fern-api/fern/pull/3633\r\ + \n* improvement, java: stop generating extra semicolon by @dcb6 in https://github.com/fern-api/fern/pull/3631\r\ + \n* chore, python: improve snippets for streaming by @armandobelardo in https://github.com/fern-api/fern/pull/3630\r\ + \n* improvement: python now respects deep object query parameters by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3629\r\n* fix: fern cli now appropriately\ + \ awaits docker pull by @armandobelardo in https://github.com/fern-api/fern/pull/3636\r\ + \n* (docs, improvement): add guide on how to publish public sdks by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3638\r\n* (feat): Add default values,\ + \ validation rules, and big integer to primitives by @dsinghvi in https://github.com/fern-api/fern/pull/3625\r\ + \n* feat: add seo and metadata configuration in docs.yml by @abvthecity in https://github.com/fern-api/fern/pull/3635\r\ + \n* Update welcome.mdx by @dannysheridan in https://github.com/fern-api/fern/pull/3637\r\ + \n* fix formatting of our own java code by @dcb6 in https://github.com/fern-api/fern/pull/3641\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.9...0.26.10-rc0" + type: chore + createdAt: "2024-05-17" + irVersion: 45 + version: 0.26.10-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, ts): Client credentials are optional with\ + \ env vars by @amckinney in https://github.com/fern-api/fern/pull/3617\r\n*\ + \ fix: upload images in changelogs by @abvthecity in https://github.com/fern-api/fern/pull/3623\r\ + \n* fix: batch image and file upload by @abvthecity in https://github.com/fern-api/fern/pull/3624\r\ + \n* chore: add nuget config for csharp sdks by @armandobelardo in https://github.com/fern-api/fern/pull/3621\r\ + \n* (feat): add java oauth generation by @dcb6 in https://github.com/fern-api/fern/pull/3614\r\ + \n* (fix): generate unknown examples as primitive by @dsinghvi in https://github.com/fern-api/fern/pull/3626\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.8...0.26.9" + type: chore + createdAt: "2024-05-15" + irVersion: 44 + version: 0.26.9 +- changelogEntry: + - summary: Release 0.26.9-rc2 + type: chore + createdAt: "2024-05-15" + irVersion: 44 + version: 0.26.9-rc2 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: batch image and file upload by @abvthecity\ + \ in https://github.com/fern-api/fern/pull/3624\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.26.9-rc0...0.26.9-rc1" + type: chore + createdAt: "2024-05-15" + irVersion: 44 + version: 0.26.9-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, ts): Client credentials are optional with\ + \ env vars by @amckinney in https://github.com/fern-api/fern/pull/3617\r\n*\ + \ fix: upload images in changelogs by @abvthecity in https://github.com/fern-api/fern/pull/3623\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.8...0.26.9\r\ + \n" + type: chore + createdAt: "2024-05-15" + irVersion: 44 + version: 0.26.9-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, openapi): Fix nameOverride resolution by\ + \ @amckinney in https://github.com/fern-api/fern/pull/3622\r\n* (docs): Add\ + \ OAuth SDK docs by @amckinney in https://github.com/fern-api/fern/pull/3615\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.7...0.26.8" + type: chore + createdAt: "2024-05-14" + irVersion: 44 + version: 0.26.8 +- changelogEntry: + - summary: "## What's Changed\r\n* [WIP] Upgrade Java Generator to IR 42 by @dcb6\ + \ in https://github.com/fern-api/fern/pull/3608\r\n* (improvement, fern): Add\ + \ better error for invalid generators.yml by @amckinney in https://github.com/fern-api/fern/pull/3521\r\ + \n* fix: fern-aware pydantic models now effectively 'exclude_optional' in\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3618\r\n* feat:\ + \ introduce pagination to python by @armandobelardo in https://github.com/fern-api/fern/pull/3604\r\ + \n* (fix, ir): Fix undiscriminated union examples by @amckinney in https://github.com/fern-api/fern/pull/3619\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.6...0.26.7" + type: chore + createdAt: "2024-05-14" + irVersion: 44 + version: 0.26.7 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, openapi): Consolidate enums into discriminants\ + \ by @amckinney in https://github.com/fern-api/fern/pull/3607\r\n* (feature,\ + \ ts): Support oauth client credentials flow by @amckinney in https://github.com/fern-api/fern/pull/3578\r\ + \n* (fix, openapi): OpenAPI importer now parses list examples that are specific\ + \ to a field by @dsinghvi in https://github.com/fern-api/fern/pull/3613\r\n\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.5...0.26.6" + type: chore + createdAt: "2024-05-14" + irVersion: 44 + version: 0.26.6 +- changelogEntry: + - summary: + "## What's Changed\r\n* (fix): eslint passes by @dsinghvi in https://github.com/fern-api/fern/pull/3603\r\ + \n* (fix, typescript): ensure formdata utils work cross-runtime by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3601\r\n* (improvement, yaml): Update\ + \ default OAuth configuration by @amckinney in https://github.com/fern-api/fern/pull/3573\r\ + \n* (feature): support `skipResponseValidation` in express handlers by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3611\r\n* (fix, changelog): relativize\ + \ changelog paths, and properly handle in tabbed docs by @abvthecity in https://github.com/fern-api/fern/pull/3610\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.4...0.26.5" + type: chore + createdAt: "2024-05-13" + irVersion: 44 + version: 0.26.5 +- changelogEntry: + - summary: "## What's Changed\r\n* (docs) Add intro section by @dannysheridan in\ + \ https://github.com/fern-api/fern/pull/3547\r\n* (chore, fastapi, ruby sdk)\ + \ release versions by @dannysheridan in https://github.com/fern-api/fern/pull/3587\r\ + \n* (chore, pydantic): Release 0.9.0 by @dannysheridan in https://github.com/fern-api/fern/pull/3586\r\ + \n* (document) reusable code snippets by @dannysheridan in https://github.com/fern-api/fern/pull/3524\r\ + \n* remove page that does not exist from docs by @armandobelardo in https://github.com/fern-api/fern/pull/3589\r\ + \n* improvement: add `extra_dev_dependencies` to python generator by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3585\r\n* feat: support Stream and\ + \ SSE in ExampleResponseSchema by @abvthecity in https://github.com/fern-api/fern/pull/3577\r\ + \n* improvement: also run fetch latest version on `fern init` by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3588\r\n* improvement: allow a break\ + \ the glass override of the min-python version by @armandobelardo in https://github.com/fern-api/fern/pull/3591\r\ + \n* feat: allow overriding api reference slug in docs by @abvthecity in https://github.com/fern-api/fern/pull/3575\r\ + \n* break: release python 2.x by @armandobelardo in https://github.com/fern-api/fern/pull/3590\r\ + \n* fix: treat multipart form as form by @abvthecity in https://github.com/fern-api/fern/pull/3553\r\ + \n* (feat, csharp): several fixes including arbitrary nested subpackage clients\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3593\r\n* (fix, csharp):\ + \ support sending inlined requests that are entirely bodies by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3594\r\n* chore: document naming and\ + \ env overrides for basic and bearer auth in\u2026 by @armandobelardo in https://github.com/fern-api/fern/pull/3596\r\ + \n* feat: streaming and sse examples by @abvthecity in https://github.com/fern-api/fern/pull/3592\r\ + \n* fix issue#3566 by @last-developer in https://github.com/fern-api/fern/pull/3597\r\ + \n* (fix, docs) webhook indentation by @dannysheridan in https://github.com/fern-api/fern/pull/3600\r\ + \n* (fix):`ir.json` are not out of date for seed by @dsinghvi in https://github.com/fern-api/fern/pull/3598\r\ + \n* (fix): `fern add` with a new `--group` works by @dsinghvi in https://github.com/fern-api/fern/pull/3602\r\ + \n\r\n## New Contributors\r\n* @last-developer made their first contribution\ + \ in https://github.com/fern-api/fern/pull/3597\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.3...0.26.4" + type: chore + createdAt: "2024-05-13" + irVersion: 44 + version: 0.26.4 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: upgrade gen version now pulls image correctly\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3584\r\n\r\n\r\ + \n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.2...0.26.3" + type: chore + createdAt: "2024-05-09" + irVersion: 43 + version: 0.26.3 +- changelogEntry: + - summary: "## What's Changed\r\n* feat, cli: add `fern generator upgrade` command\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3535\r\n* (fix,\ + \ internal): typescript generators depend on latest ir by @dsinghvi in https://github.com/fern-api/fern/pull/3583\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.26.1...0.26.2" + type: chore + createdAt: "2024-05-09" + irVersion: 43 + version: 0.26.2 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat, docs): send status code to fdr by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3582\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.26.0...0.26.1" + type: chore + createdAt: "2024-05-09" + irVersion: 43 + version: 0.26.1 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat, definition): support response status codes\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3580\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.25.0...0.26.0" + type: chore + createdAt: "2024-05-09" + irVersion: 43 + version: 0.26.0 +- changelogEntry: + - summary: "## What's Changed\r\n* feat: add origin and ability to update API spec\ + \ via CLI by @armandobelardo in https://github.com/fern-api/fern/pull/3533\r\ + \n* internal: add in tags and labels for docker images for use in upgrade\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3542\r\n* Bump\ + \ @fern-api/fdr-sdk from 0.82.1-32d571a0d to 0.82.1-6020e1266 by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3540\r\n* (improvement, express):\ + \ Remove unnecessary console.error by @amckinney in https://github.com/fern-api/fern/pull/3541\r\ + \n* fix: update docker cli usage for ts sdks by @armandobelardo in https://github.com/fern-api/fern/pull/3544\r\ + \n* (feat, cli): introduce error examples in the fern definition by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3546\r\n* (feat, ir): add example\ + \ errors to ir and fdr by @dsinghvi in https://github.com/fern-api/fern/pull/3548\r\ + \n* (feature, ts): Support upload endpoints with file arrays by @amckinney in\ + \ https://github.com/fern-api/fern/pull/3543\r\n* (fix): ete tests are green\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3550\r\n* (fix): openapi\ + \ ir to fern carries through error examples by @dsinghvi in https://github.com/fern-api/fern/pull/3551\r\ + \n* (fix): pass in example.value to error converter by @dsinghvi in https://github.com/fern-api/fern/pull/3554\r\ + \n* (fix, openapi): Recursively visit nested anyOf schemas by @amckinney in\ + \ https://github.com/fern-api/fern/pull/3536\r\n* (express): Release 0.12.0-rc2\ + \ by @amckinney in https://github.com/fern-api/fern/pull/3555\r\n* fix, java:\ + \ do not require non-auth headers if auth is mandatory by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3549\r\n* (fix): add `node-gyp` to make\ + \ yarn installs faster by @dsinghvi in https://github.com/fern-api/fern/pull/3552\r\ + \n* Revert \"(fix): add `node-gyp` to make yarn installs faster\" by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3558\r\n* (fix): OpenAPI converter\ + \ only adds unique error examples by @dsinghvi in https://github.com/fern-api/fern/pull/3556\r\ + \n* (fix, go): Disable url tags for in-lined body properties by @amckinney in\ + \ https://github.com/fern-api/fern/pull/3557\r\n* (feat, express): add `skipRequestValidation`\ + \ configuration to the express generator by @dsinghvi in https://github.com/fern-api/fern/pull/3560\r\ + \n* (fix) [wip] java empty response body instead of null by @dcb6 in https://github.com/fern-api/fern/pull/3545\r\ + \n* Document new `background` prop for `Frame` component by @KenzoBenzo in https://github.com/fern-api/fern/pull/3559\r\ + \n* (improvment, ir): Improve OAuth IR customizability by @amckinney in https://github.com/fern-api/fern/pull/3563\r\ + \n* (docs) consolidate code snippets and code block markdown pages by @abvthecity\ + \ in https://github.com/fern-api/fern/pull/3562\r\n* fix: deduplicate image\ + \ filepaths to upload by @abvthecity in https://github.com/fern-api/fern/pull/3564\r\ + \n* (fix, internal): seed exits when docker fails to build by @dsinghvi in https://github.com/fern-api/fern/pull/3568\r\ + \n* (internal, fix): rewrite inputs and run seed on ir changes by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3569\r\n* fix: do not add header\ + \ to java map unless not null by @armandobelardo in https://github.com/fern-api/fern/pull/3567\r\ + \n* (fix, docs): improve docs on augmenting generators with customization by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/3570\r\n* docs: sidebar\ + \ icons by @abvthecity in https://github.com/fern-api/fern/pull/3574\r\n* fix:\ + \ perform the correct null check on headers by @armandobelardo in https://github.com/fern-api/fern/pull/3571\r\ + \n* fix, ir: fall back to the generated name when creating schemas if the\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3572\r\n\r\n##\ + \ New Contributors\r\n* @dcb6 made their first contribution in https://github.com/fern-api/fern/pull/3545\r\ + \n* @KenzoBenzo made their first contribution in https://github.com/fern-api/fern/pull/3559\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.24.0...0.25.0" + type: chore + createdAt: "2024-05-08" + irVersion: 42 + version: 0.25.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (express): Release 0.12.0-rc2 by @amckinney in\ + \ https://github.com/fern-api/fern/pull/3555\r\n* fix, java: do not require\ + \ non-auth headers if auth is mandatory by @armandobelardo in https://github.com/fern-api/fern/pull/3549\r\ + \n* (fix): OpenAPI converter only adds unique error examples by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3556\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.25.0-rc2...0.25.0-rc3" + type: chore + createdAt: "2024-05-07" + irVersion: 41 + version: 0.25.0-rc3 +- changelogEntry: + - summary: "## What's Changed\r\n* feat: add origin and ability to update API spec\ + \ via CLI by @armandobelardo in https://github.com/fern-api/fern/pull/3533\r\ + \n* internal: add in tags and labels for docker images for use in upgrade\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3542\r\n* Bump\ + \ @fern-api/fdr-sdk from 0.82.1-32d571a0d to 0.82.1-6020e1266 by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3540\r\n* (improvement, express):\ + \ Remove unnecessary console.error by @amckinney in https://github.com/fern-api/fern/pull/3541\r\ + \n* fix: update docker cli usage for ts sdks by @armandobelardo in https://github.com/fern-api/fern/pull/3544\r\ + \n* (feat, cli): introduce error examples in the fern definition by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3546\r\n* (feat, ir): add example\ + \ errors to ir and fdr by @dsinghvi in https://github.com/fern-api/fern/pull/3548\r\ + \n* (feature, ts): Support upload endpoints with file arrays by @amckinney in\ + \ https://github.com/fern-api/fern/pull/3543\r\n* (fix): ete tests are green\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3550\r\n* (fix): openapi\ + \ ir to fern carries through error examples by @dsinghvi in https://github.com/fern-api/fern/pull/3551\r\ + \n* (fix): pass in example.value to error converter by @dsinghvi in https://github.com/fern-api/fern/pull/3554\r\ + \n* (fix, openapi): Recursively visit nested anyOf schemas by @amckinney in\ + \ https://github.com/fern-api/fern/pull/3536\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.24.0...0.25.0-rc2" + type: chore + createdAt: "2024-05-07" + irVersion: 41 + version: 0.25.0-rc2 +- changelogEntry: + - summary: "## What's Changed\r\n* feat: add origin and ability to update API spec\ + \ via CLI by @armandobelardo in https://github.com/fern-api/fern/pull/3533\r\ + \n* internal: add in tags and labels for docker images for use in upgrade\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3542\r\n* Bump\ + \ @fern-api/fdr-sdk from 0.82.1-32d571a0d to 0.82.1-6020e1266 by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3540\r\n* (improvement, express):\ + \ Remove unnecessary console.error by @amckinney in https://github.com/fern-api/fern/pull/3541\r\ + \n* fix: update docker cli usage for ts sdks by @armandobelardo in https://github.com/fern-api/fern/pull/3544\r\ + \n* (feat, cli): introduce error examples in the fern definition by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3546\r\n* (feat, ir): add example\ + \ errors to ir and fdr by @dsinghvi in https://github.com/fern-api/fern/pull/3548\r\ + \n* (feature, ts): Support upload endpoints with file arrays by @amckinney in\ + \ https://github.com/fern-api/fern/pull/3543\r\n* (fix): ete tests are green\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3550\r\n* (fix): openapi\ + \ ir to fern carries through error examples by @dsinghvi in https://github.com/fern-api/fern/pull/3551\r\ + \n* (fix): pass in example.value to error converter by @dsinghvi in https://github.com/fern-api/fern/pull/3554\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.24.0...0.25.0-rc1" + type: chore + createdAt: "2024-05-07" + irVersion: 41 + version: 0.25.0-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* feat: add origin and ability to update API spec\ + \ via CLI by @armandobelardo in https://github.com/fern-api/fern/pull/3533\r\ + \n* internal: add in tags and labels for docker images for use in upgrade\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3542\r\n* Bump\ + \ @fern-api/fdr-sdk from 0.82.1-32d571a0d to 0.82.1-6020e1266 by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3540\r\n* (improvement, express):\ + \ Remove unnecessary console.error by @amckinney in https://github.com/fern-api/fern/pull/3541\r\ + \n* fix: update docker cli usage for ts sdks by @armandobelardo in https://github.com/fern-api/fern/pull/3544\r\ + \n* (feat, cli): introduce error examples in the fern definition by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3546\r\n* (feat, ir): add example\ + \ errors to ir and fdr by @dsinghvi in https://github.com/fern-api/fern/pull/3548\r\ + \n* (feature, ts): Support upload endpoints with file arrays by @amckinney in\ + \ https://github.com/fern-api/fern/pull/3543\r\n* (fix): ete tests are green\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3550\r\n* (fix): openapi\ + \ ir to fern carries through error examples by @dsinghvi in https://github.com/fern-api/fern/pull/3551\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.24.0...0.25.0-rc0" + type: chore + createdAt: "2024-05-07" + irVersion: 41 + version: 0.25.0-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): remove `api.yml` not found error when\ + \ the openapi folder is present by @dsinghvi in https://github.com/fern-api/fern/pull/3519\r\ + \n* add example snippet syntax by @abvthecity in https://github.com/fern-api/fern/pull/3523\r\ + \n* (fix, internal): fix preview docs and move props to left side in docs by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/3525\r\n* fix, python:\ + \ check for nulls before dereferencing in unchecked base m\u2026 by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3528\r\n* (feature, openapi): Add\ + \ x-fern-base-path extension by @amckinney in https://github.com/fern-api/fern/pull/3530\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.23.7...0.24.0" + type: chore + createdAt: "2024-05-06" + irVersion: 40 + version: 0.24.0 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: The vanilla pydantic base model now respects\ + \ the by @armandobelardo in https://github.com/fern-api/fern/pull/3504\r\n*\ + \ (fix): support parsing path parameters in asyncapi v2 by @dsinghvi in https://github.com/fern-api/fern/pull/3505\r\ + \n* (internal, test): Stop testing IR generation snapshots by @dsinghvi in https://github.com/fern-api/fern/pull/3508\r\ + \n* fix, python: pipe through the whole kit and caboodle for inlined unions\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3507\r\n* fix,\ + \ python: the SDK generator now generates disciminated unions correctlly by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3509\r\n* internal:\ + \ release python generator RC by @armandobelardo in https://github.com/fern-api/fern/pull/3510\r\ + \n* fix, ts, python: snippet template paper cuts by @armandobelardo in https://github.com/fern-api/fern/pull/3511\r\ + \n* (fix, ts): Prefer user-provided examples by @amckinney in https://github.com/fern-api/fern/pull/3496\r\ + \n* (fix, ts): Add URL encoding to path parameters by @amckinney in https://github.com/fern-api/fern/pull/3494\r\ + \n* (docs) aside component by @dannysheridan in https://github.com/fern-api/fern/pull/3512\r\ + \n* internal: update public api docs by @armandobelardo in https://github.com/fern-api/fern/pull/3513\r\ + \n* (feature, ts): Add JSDoc docs to client methods by @amckinney in https://github.com/fern-api/fern/pull/3515\r\ + \n* improvement: add in sync templates for python (in addition to async) by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3516\r\n* (chore,\ + \ python): Ignore core_utilities in mypy by @amckinney in https://github.com/fern-api/fern/pull/3517\r\ + \n* (feature): expose `x-fern-property-name` extension by @dsinghvi in https://github.com/fern-api/fern/pull/3518\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.23.6...0.23.7" + type: chore + createdAt: "2024-05-02" + irVersion: 40 + version: 0.23.7 +- changelogEntry: + - summary: "## What's Changed\r\n* docs: Add services to entities with `availability`\ + \ by @jackfischer in https://github.com/fern-api/fern/pull/3500\r\n* fix typo\ + \ in docs by @rnz269 in https://github.com/fern-api/fern/pull/3502\r\n* fix:\ + \ filter allOf schemas to look for objects instead of malformed bl\u2026 by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3503\r\n\r\n## New\ + \ Contributors\r\n* @rnz269 made their first contribution in https://github.com/fern-api/fern/pull/3502\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.23.5...0.23.6" + type: chore + createdAt: "2024-05-01" + irVersion: 40 + version: 0.23.6 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): literal descriptions from OpenAPI by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3501\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.23.4...0.23.5" + type: chore + createdAt: "2024-05-01" + irVersion: 40 + version: 0.23.5 +- changelogEntry: + - summary: "## What's Changed\r\n* improvements, python: update docstrings to match\ + \ numpydoc convention by @armandobelardo in https://github.com/fern-api/fern/pull/3487\r\ + \n* feat, python: introduce flag to inline request params in function sig\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3491\r\n* (fix,\ + \ go): Add URL encoding to path parameters by @amckinney in https://github.com/fern-api/fern/pull/3488\r\ + \n* (feat, internal): introduce default custom config and use in express generator\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3493\r\n* (fix, python):\ + \ re-add inlining union properties by @armandobelardo in https://github.com/fern-api/fern/pull/3476\r\ + \n* feat: tabs with href by @abvthecity in https://github.com/fern-api/fern/pull/3497\r\ + \n* feat: in docs.yml, allow api reference to be \"flattened\" by @abvthecity\ + \ in https://github.com/fern-api/fern/pull/3498\r\n* fix, ts: remove duplicate\ + \ quotation marks from snippet templates by @armandobelardo in https://github.com/fern-api/fern/pull/3495\r\ + \n* fix: address formatting issues with python templates by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3499\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.23.3...0.23.4" + type: chore + createdAt: "2024-05-01" + irVersion: 40 + version: 0.23.4 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): send file arrays to fdr by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3492\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.23.2...0.23.3" + type: chore + createdAt: "2024-04-30" + irVersion: 40 + version: 0.23.3 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement: throw a better error when an invalid\ + \ version is used by @armandobelardo in https://github.com/fern-api/fern/pull/3477\r\ + \n* (fix, go): Discrimninated unions always include discriminant by @amckinney\ + \ in https://github.com/fern-api/fern/pull/3479\r\n* (internal, feat): add \ + \ mode to seed for running the generators directly from source by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3421\r\n* (fix, docs): improve docs\ + \ overview by @dsinghvi in https://github.com/fern-api/fern/pull/3480\r\n* (docs,\ + \ quickstart): rewrite the docs quickstart by @dsinghvi in https://github.com/fern-api/fern/pull/3481\r\ + \n* docs: add pages for api reference navigation and summary markdown by @abvthecity\ + \ in https://github.com/fern-api/fern/pull/3482\r\n* (chore): parse file upload\ + \ and their descriptions by @dsinghvi in https://github.com/fern-api/fern/pull/3485\r\ + \n* (feature, go): Add cursor and offset pagination by @amckinney in https://github.com/fern-api/fern/pull/3486\r\ + \n* (fix): redo docs for accordion, accorodion groups, callouts, card groups,\ + \ etc. by @dsinghvi in https://github.com/fern-api/fern/pull/3489\r\n* (fix,\ + \ docs): document frames and endpoint req/res snippets by @dsinghvi in https://github.com/fern-api/fern/pull/3490\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.23.1...0.23.2" + type: chore + createdAt: "2024-04-30" + irVersion: 40 + version: 0.23.2 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: run seed to get CI to green by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3463\r\n* (feature, go): Add support\ + \ for extra properties by @amckinney in https://github.com/fern-api/fern/pull/3462\r\ + \n* fix: try ignoring the .mock folder, whos diff doesn't matter by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3465\r\n* feat: support multiple\ + \ custom domains by @abvthecity in https://github.com/fern-api/fern/pull/3466\r\ + \n* fix: migrating docs.yml to 0.15.0-rc0 should fail if custom-domain is an\ + \ array by @abvthecity in https://github.com/fern-api/fern/pull/3467\r\n* (feat):\ + \ introduce an audiences config to load filtered OpenAPIs by @dsinghvi in https://github.com/fern-api/fern/pull/3468\r\ + \n* add logging to ts snippet template generation by @armandobelardo in https://github.com/fern-api/fern/pull/3469\r\ + \n* fix: fix indentation level for ts templates by @armandobelardo in https://github.com/fern-api/fern/pull/3470\r\ + \n* (fix, go): Only use omitempty for nil-able types by @amckinney in https://github.com/fern-api/fern/pull/3471\r\ + \n* (fix): backfill SSE events as streaming json by @dsinghvi in https://github.com/fern-api/fern/pull/3472\r\ + \n* Add image parsing to cli by @jhpak22 in https://github.com/fern-api/fern/pull/3193\r\ + \n* (docs): add docs about defining webhooks in the fern definition by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3473\r\n* Fix typo in forward-compatibility.mdx\ + \ by @zachkirsch in https://github.com/fern-api/fern/pull/3474\r\n* fix: broken\ + \ docs post-processor by @abvthecity in https://github.com/fern-api/fern/pull/3475\r\ + \n\r\n## New Contributors\r\n* @jhpak22 made their first contribution in https://github.com/fern-api/fern/pull/3193\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.23.0...0.23.1-rc6" + type: chore + createdAt: "2024-04-26" + irVersion: 40 + version: 0.23.1-rc6 +- changelogEntry: + - summary: Release 0.23.1 + type: chore + createdAt: "2024-04-26" + irVersion: 40 + version: 0.23.1 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: run seed to get CI to green by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3463\r\n* (feature, go): Add support\ + \ for extra properties by @amckinney in https://github.com/fern-api/fern/pull/3462\r\ + \n* fix: try ignoring the .mock folder, whos diff doesn't matter by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3465\r\n* feat: support multiple\ + \ custom domains by @abvthecity in https://github.com/fern-api/fern/pull/3466\r\ + \n* fix: migrating docs.yml to 0.15.0-rc0 should fail if custom-domain is an\ + \ array by @abvthecity in https://github.com/fern-api/fern/pull/3467\r\n* (feat):\ + \ introduce an audiences config to load filtered OpenAPIs by @dsinghvi in https://github.com/fern-api/fern/pull/3468\r\ + \n* add logging to ts snippet template generation by @armandobelardo in https://github.com/fern-api/fern/pull/3469\r\ + \n* fix: fix indentation level for ts templates by @armandobelardo in https://github.com/fern-api/fern/pull/3470\r\ + \n* (fix, go): Only use omitempty for nil-able types by @amckinney in https://github.com/fern-api/fern/pull/3471\r\ + \n* (fix): backfill SSE events as streaming json by @dsinghvi in https://github.com/fern-api/fern/pull/3472\r\ + \n* Add image parsing to cli by @jhpak22 in https://github.com/fern-api/fern/pull/3193\r\ + \n* (docs): add docs about defining webhooks in the fern definition by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3473\r\n* Fix typo in forward-compatibility.mdx\ + \ by @zachkirsch in https://github.com/fern-api/fern/pull/3474\r\n\r\n## New\ + \ Contributors\r\n* @jhpak22 made their first contribution in https://github.com/fern-api/fern/pull/3193\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.23.0...0.23.1-rc5" + type: chore + createdAt: "2024-04-26" + irVersion: 40 + version: 0.23.1-rc5 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: run seed to get CI to green by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3463\r\n* (feature, go): Add support\ + \ for extra properties by @amckinney in https://github.com/fern-api/fern/pull/3462\r\ + \n* fix: try ignoring the .mock folder, whos diff doesn't matter by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3465\r\n* feat: support multiple\ + \ custom domains by @abvthecity in https://github.com/fern-api/fern/pull/3466\r\ + \n* fix: migrating docs.yml to 0.15.0-rc0 should fail if custom-domain is an\ + \ array by @abvthecity in https://github.com/fern-api/fern/pull/3467\r\n* (feat):\ + \ introduce an audiences config to load filtered OpenAPIs by @dsinghvi in https://github.com/fern-api/fern/pull/3468\r\ + \n* add logging to ts snippet template generation by @armandobelardo in https://github.com/fern-api/fern/pull/3469\r\ + \n* fix: fix indentation level for ts templates by @armandobelardo in https://github.com/fern-api/fern/pull/3470\r\ + \n* (fix, go): Only use omitempty for nil-able types by @amckinney in https://github.com/fern-api/fern/pull/3471\r\ + \n* (fix): backfill SSE events as streaming json by @dsinghvi in https://github.com/fern-api/fern/pull/3472\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.23.0...0.23.1-rc4" + type: chore + createdAt: "2024-04-26" + irVersion: 40 + version: 0.23.1-rc4 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: run seed to get CI to green by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3463\r\n* (feature, go): Add support\ + \ for extra properties by @amckinney in https://github.com/fern-api/fern/pull/3462\r\ + \n* fix: try ignoring the .mock folder, whos diff doesn't matter by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3465\r\n* feat: support multiple\ + \ custom domains by @abvthecity in https://github.com/fern-api/fern/pull/3466\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.23.0...0.23.1-rc1" + type: chore + createdAt: "2024-04-25" + irVersion: 40 + version: 0.23.1-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: run seed to get CI to green by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3463\r\n* (feature, go): Add support\ + \ for extra properties by @amckinney in https://github.com/fern-api/fern/pull/3462\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.23.0...0.23.1-rc0" + type: chore + createdAt: "2024-04-25" + irVersion: 40 + version: 0.23.1-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat): add `format` to the `x-fern-streaming`\ + \ extension to support sse by @dsinghvi in https://github.com/fern-api/fern/pull/3407\r\ + \n* Revert \"(fix): inline discriminated union props\" by @dsinghvi in https://github.com/fern-api/fern/pull/3408\r\ + \n* (fix): python generator imports `json` when deserializing server sent events\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3409\r\n* (feature):\ + \ Add OAuth to IR by @amckinney in https://github.com/fern-api/fern/pull/3410\r\ + \n* (feat, ts): support server-sent events by @dsinghvi in https://github.com/fern-api/fern/pull/3411\r\ + \n* (feat, docs): create a api definition tab before sdks and docs by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3413\r\n* (fix): setup local cli\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3416\r\n* (fix): fixes\ + \ trailing slash parsing in openapi-parser, updates tests by @franklinharvey\ + \ in https://github.com/fern-api/fern/pull/3418\r\n* (fix): fixes trailing slash\ + \ additional test by @franklinharvey in https://github.com/fern-api/fern/pull/3419\r\ + \n* (internal, seed): heavy rewrite of seed by @dsinghvi in https://github.com/fern-api/fern/pull/3297\r\ + \n* feat: register snippet templates by @armandobelardo in https://github.com/fern-api/fern/pull/3400\r\ + \n* (feat): release python sdk generator by @dsinghvi in https://github.com/fern-api/fern/pull/3423\r\ + \n* internal: add logging to python template generation by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3424\r\n* fix: fix debug log in template\ + \ generator by @armandobelardo in https://github.com/fern-api/fern/pull/3426\r\ + \n* fix, internal: leverage the union factory to create the generic templ\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3427\r\n* fix,\ + \ python: add best-case formatting to snippet templates by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3428\r\n* (fix, typescript): respect\ + \ stream terminator by @dsinghvi in https://github.com/fern-api/fern/pull/3429\r\ + \n* fix: use relative location for containers, not it's parent's location by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3431\r\n* fix: do\ + \ not stringify null headers by @armandobelardo in https://github.com/fern-api/fern/pull/3433\r\ + \n* fix: parse map example by @abvthecity in https://github.com/fern-api/fern/pull/3434\r\ + \n* fix: skipUrlSlug in api section by @abvthecity in https://github.com/fern-api/fern/pull/3435\r\ + \n* Fixes validation rules for path and base-path by @franklinharvey in https://github.com/fern-api/fern/pull/3420\r\ + \n* (fix): get ci to green by @dsinghvi in https://github.com/fern-api/fern/pull/3437\r\ + \n* chore, python: follow redirects by default by @armandobelardo in https://github.com/fern-api/fern/pull/3436\r\ + \n* (feature, python): Add OAuth token provider by @amckinney in https://github.com/fern-api/fern/pull/3439\r\ + \n* improvement, oas: do not require schema to be present to parse response\ + \ objects by @armandobelardo in https://github.com/fern-api/fern/pull/3438\r\ + \n* feat: show error schemas in docs by @abvthecity in https://github.com/fern-api/fern/pull/3401\r\ + \n* (fix): OAuth is migrated back to bearer by @amckinney in https://github.com/fern-api/fern/pull/3440\r\ + \n* chore: transition snippets api to monorepo by @armandobelardo in https://github.com/fern-api/fern/pull/3442\r\ + \n* Update what-is-an-api-definition.mdx by @bsinghvi in https://github.com/fern-api/fern/pull/3443\r\ + \n* (fix, python): OAuthTokenProvider initializes all private member variables\ + \ by @amckinney in https://github.com/fern-api/fern/pull/3444\r\n* (fix): seed\ + \ run with custom fixture works by @dsinghvi in https://github.com/fern-api/fern/pull/3445\r\ + \n* (feature): Add support for extra-properties by @amckinney in https://github.com/fern-api/fern/pull/3441\r\ + \n* chore: add a lot of logging and attempt to optimize rubocop config by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3447\r\n* (fix): ts seed debugging\ + \ works by @dsinghvi in https://github.com/fern-api/fern/pull/3446\r\n* (feat):\ + \ support text responses in typescript by @dsinghvi in https://github.com/fern-api/fern/pull/3451\r\ + \n* fix: subpackage uses original name by @abvthecity in https://github.com/fern-api/fern/pull/3452\r\ + \n* (fix, python): Use kwargs for all httpx params by @amckinney in https://github.com/fern-api/fern/pull/3454\r\ + \n* fix: do not fail hard if FDR is having problems by @armandobelardo in https://github.com/fern-api/fern/pull/3455\r\ + \n* (chore): Update all seed snapshots by @amckinney in https://github.com/fern-api/fern/pull/3456\r\ + \n* (chore): Add better Python CHANGELOG.md entry by @amckinney in https://github.com/fern-api/fern/pull/3457\r\ + \n* (fix, typescript): handle empty sse events by @dsinghvi in https://github.com/fern-api/fern/pull/3458\r\ + \n* (improvement): appending type for type exports by @bsinghvi in https://github.com/fern-api/fern/pull/3405\r\ + \n* Updating TS seed generated files by @bsinghvi in https://github.com/fern-api/fern/pull/3459\r\ + \n* Fixing API First Development box link by @bsinghvi in https://github.com/fern-api/fern/pull/3460\r\ + \n* Switching product card ordering on welcome by @bsinghvi in https://github.com/fern-api/fern/pull/3461\r\ + \n* feat, ts: introduce snippet template creation by @armandobelardo in https://github.com/fern-api/fern/pull/3450\r\ + \n* (fix): openapi converter handles missing schemas by @dsinghvi in https://github.com/fern-api/fern/pull/3464\r\ + \n\r\n## New Contributors\r\n* @franklinharvey made their first contribution\ + \ in https://github.com/fern-api/fern/pull/3418\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.22.0...0.23.0" + type: chore + createdAt: "2024-04-25" + irVersion: 40 + version: 0.23.0 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement, oas: do not require schema to be\ + \ present to parse response objects by @armandobelardo in https://github.com/fern-api/fern/pull/3438\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.23.0-rc5...0.23.0-rc6" + type: chore + createdAt: "2024-04-23" + irVersion: 39 + version: 0.23.0-rc6 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat): add `format` to the `x-fern-streaming`\ + \ extension to support sse by @dsinghvi in https://github.com/fern-api/fern/pull/3407\r\ + \n* Revert \"(fix): inline discriminated union props\" by @dsinghvi in https://github.com/fern-api/fern/pull/3408\r\ + \n* (fix): python generator imports `json` when deserializing server sent events\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3409\r\n* (feature):\ + \ Add OAuth to IR by @amckinney in https://github.com/fern-api/fern/pull/3410\r\ + \n* (feat, ts): support server-sent events by @dsinghvi in https://github.com/fern-api/fern/pull/3411\r\ + \n* (feat, docs): create a api definition tab before sdks and docs by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3413\r\n* (fix): setup local cli\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3416\r\n* (fix): fixes\ + \ trailing slash parsing in openapi-parser, updates tests by @franklinharvey\ + \ in https://github.com/fern-api/fern/pull/3418\r\n* (fix): fixes trailing slash\ + \ additional test by @franklinharvey in https://github.com/fern-api/fern/pull/3419\r\ + \n* (internal, seed): heavy rewrite of seed by @dsinghvi in https://github.com/fern-api/fern/pull/3297\r\ + \n* feat: register snippet templates by @armandobelardo in https://github.com/fern-api/fern/pull/3400\r\ + \n* (feat): release python sdk generator by @dsinghvi in https://github.com/fern-api/fern/pull/3423\r\ + \n* internal: add logging to python template generation by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3424\r\n* fix: fix debug log in template\ + \ generator by @armandobelardo in https://github.com/fern-api/fern/pull/3426\r\ + \n* fix, internal: leverage the union factory to create the generic templ\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3427\r\n* fix,\ + \ python: add best-case formatting to snippet templates by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3428\r\n* (fix, typescript): respect\ + \ stream terminator by @dsinghvi in https://github.com/fern-api/fern/pull/3429\r\ + \n* fix: use relative location for containers, not it's parent's location by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3431\r\n* fix: do\ + \ not stringify null headers by @armandobelardo in https://github.com/fern-api/fern/pull/3433\r\ + \n* fix: parse map example by @abvthecity in https://github.com/fern-api/fern/pull/3434\r\ + \n* fix: skipUrlSlug in api section by @abvthecity in https://github.com/fern-api/fern/pull/3435\r\ + \n* Fixes validation rules for path and base-path by @franklinharvey in https://github.com/fern-api/fern/pull/3420\r\ + \n* (fix): get ci to green by @dsinghvi in https://github.com/fern-api/fern/pull/3437\r\ + \n* chore, python: follow redirects by default by @armandobelardo in https://github.com/fern-api/fern/pull/3436\r\ + \n* (feature, python): Add OAuth token provider by @amckinney in https://github.com/fern-api/fern/pull/3439\r\ + \n\r\n## New Contributors\r\n* @franklinharvey made their first contribution\ + \ in https://github.com/fern-api/fern/pull/3418\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.22.0...0.23.0-rc5" + type: chore + createdAt: "2024-04-23" + irVersion: 39 + version: 0.23.0-rc5 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat): add `format` to the `x-fern-streaming`\ + \ extension to support sse by @dsinghvi in https://github.com/fern-api/fern/pull/3407\r\ + \n* Revert \"(fix): inline discriminated union props\" by @dsinghvi in https://github.com/fern-api/fern/pull/3408\r\ + \n* (fix): python generator imports `json` when deserializing server sent events\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3409\r\n* (feature):\ + \ Add OAuth to IR by @amckinney in https://github.com/fern-api/fern/pull/3410\r\ + \n* (feat, ts): support server-sent events by @dsinghvi in https://github.com/fern-api/fern/pull/3411\r\ + \n* (feat, docs): create a api definition tab before sdks and docs by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3413\r\n* (fix): setup local cli\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3416\r\n* (fix): fixes\ + \ trailing slash parsing in openapi-parser, updates tests by @franklinharvey\ + \ in https://github.com/fern-api/fern/pull/3418\r\n* (fix): fixes trailing slash\ + \ additional test by @franklinharvey in https://github.com/fern-api/fern/pull/3419\r\ + \n* (internal, seed): heavy rewrite of seed by @dsinghvi in https://github.com/fern-api/fern/pull/3297\r\ + \n* feat: register snippet templates by @armandobelardo in https://github.com/fern-api/fern/pull/3400\r\ + \n* (feat): release python sdk generator by @dsinghvi in https://github.com/fern-api/fern/pull/3423\r\ + \n* internal: add logging to python template generation by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3424\r\n* fix: fix debug log in template\ + \ generator by @armandobelardo in https://github.com/fern-api/fern/pull/3426\r\ + \n* fix, internal: leverage the union factory to create the generic templ\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3427\r\n* fix,\ + \ python: add best-case formatting to snippet templates by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3428\r\n* (fix, typescript): respect\ + \ stream terminator by @dsinghvi in https://github.com/fern-api/fern/pull/3429\r\ + \n* fix: use relative location for containers, not it's parent's location by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/3431\r\n* fix: do\ + \ not stringify null headers by @armandobelardo in https://github.com/fern-api/fern/pull/3433\r\ + \n* fix: parse map example by @abvthecity in https://github.com/fern-api/fern/pull/3434\r\ + \n* fix: skipUrlSlug in api section by @abvthecity in https://github.com/fern-api/fern/pull/3435\r\ + \n* Fixes validation rules for path and base-path by @franklinharvey in https://github.com/fern-api/fern/pull/3420\r\ + \n* (fix): get ci to green by @dsinghvi in https://github.com/fern-api/fern/pull/3437\r\ + \n\r\n## New Contributors\r\n* @franklinharvey made their first contribution\ + \ in https://github.com/fern-api/fern/pull/3418\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.22.0...0.23.0-rc4" + type: chore + createdAt: "2024-04-23" + irVersion: 39 + version: 0.23.0-rc4 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore, docs): document automated registry publishing)\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3379\r\n* (feature):\ + \ Add allowExtraFields configuration to TypeScript generators by @amckinney\ + \ in https://github.com/fern-api/fern/pull/3368\r\n* fix: address parsed_json\ + \ instantiation for serializable object types by @armandobelardo in https://github.com/fern-api/fern/pull/3382\r\ + \n* Fix typo in SDK docs page by @zachkirsch in https://github.com/fern-api/fern/pull/3383\r\ + \n* (chore): upgrade fern version by @dannysheridan in https://github.com/fern-api/fern/pull/3376\r\ + \n* fix: support multiple request and response examples automatically by @abvthecity\ + \ in https://github.com/fern-api/fern/pull/3384\r\n* (fix): discriminated union\ + \ schema examples don't contain discriminants by @dsinghvi in https://github.com/fern-api/fern/pull/3386\r\ + \n* (fix): make sure versioned tabbed config works by @dsinghvi in https://github.com/fern-api/fern/pull/3387\r\ + \n* (fix): Go path parameter order by @amckinney in https://github.com/fern-api/fern/pull/3385\r\ + \n* (feature): Go supports environment variable scanning by @amckinney in https://github.com/fern-api/fern/pull/3389\r\ + \n* (fix): only generate unit tests when enabled by @dsinghvi in https://github.com/fern-api/fern/pull/3390\r\ + \n* (fix): update `node-fetch` import to be dynamic by @dsinghvi in https://github.com/fern-api/fern/pull/3391\r\ + \n* (fix): Generate TS snippets for file download by @bsinghvi in https://github.com/fern-api/fern/pull/3394\r\ + \n* (feat): support sse with arbitrary terminators by @dsinghvi in https://github.com/fern-api/fern/pull/3395\r\ + \n* (improvement): add return type for getAuthorizationHeader by @bsinghvi in\ + \ https://github.com/fern-api/fern/pull/3396\r\n* (feat): make module imports\ + \ directly point to index.js by @dsinghvi in https://github.com/fern-api/fern/pull/3397\r\ + \n* (fix): generate basic tests when integration tests disabled by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3398\r\n* (fix, typescript): do file\ + \ upload snippet generation by @dsinghvi in https://github.com/fern-api/fern/pull/3399\r\ + \n* (feature): Add OAuth YAML and validator by @amckinney in https://github.com/fern-api/fern/pull/3403\r\ + \n* (feat, python): support sse by @dsinghvi in https://github.com/fern-api/fern/pull/3402\r\ + \n* (fix): inline discriminated union props by @dsinghvi in https://github.com/fern-api/fern/pull/3404\r\ + \n\r\n## New Contributors\r\n* @bsinghvi made their first contribution in https://github.com/fern-api/fern/pull/3394\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.21.0...0.22.0" + type: chore + createdAt: "2024-04-19" + irVersion: 38 + version: 0.22.0 +- changelogEntry: + - summary: "## What's Changed\r\n* improvements: misc ruby QOL changes by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3349\r\n* fix readme links to images\ + \ that were moved from /docs/images by @harry-humanloop in https://github.com/fern-api/fern/pull/3355\r\ + \n* additional ruby fixes to the 0.5.0 overhaul by @armandobelardo in https://github.com/fern-api/fern/pull/3359\r\ + \n* (chore): setup docs landing page by @dsinghvi in https://github.com/fern-api/fern/pull/3361\r\ + \n* (feature): Implement fern generate --preview by @amckinney in https://github.com/fern-api/fern/pull/3363\r\ + \n* chore: add learn to welcome links hrefs by @dannysheridan in https://github.com/fern-api/fern/pull/3369\r\ + \n* build(deps): bump tar from 4.4.19 to 6.2.1 by @dependabot in https://github.com/fern-api/fern/pull/3348\r\ + \n* fix, ruby: call json.parse before iterating through response by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3367\r\n* feat: introduce snippets\ + \ for Ruby SDKs by @armandobelardo in https://github.com/fern-api/fern/pull/3370\r\ + \n* (chore): fix title in front matter for docs by @dannysheridan in https://github.com/fern-api/fern/pull/3375\r\ + \n* improvement: pass snippets version to fdr to register docs with snippets\ + \ at a specific version by @armandobelardo in https://github.com/fern-api/fern/pull/3374\r\ + \n* (feat): redo SDKs documentation by @dsinghvi in https://github.com/fern-api/fern/pull/3365\r\ + \n* (feat, docs): explain registering and depending on api artifacts by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3377\r\n* fix: update IR for the\ + \ TS SDK by @armandobelardo in https://github.com/fern-api/fern/pull/3378\r\n\ + \r\n## New Contributors\r\n* @harry-humanloop made their first contribution\ + \ in https://github.com/fern-api/fern/pull/3355\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.20.0...0.21.0" + type: chore + createdAt: "2024-04-15" + irVersion: 37 + version: 0.21.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): code blocks are valid by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3337\r\n* improvement, ruby: add and\ + \ run rake to run dummy test for build errors by @armandobelardo in https://github.com/fern-api/fern/pull/3330\r\ + \n* add api origin to generators config by @armandobelardo in https://github.com/fern-api/fern/pull/3336\r\ + \n* build(deps): bump github.com/fern-api/generator-exec-go from 0.0.694 to\ + \ 0.0.702 in /generators/go by @dependabot in https://github.com/fern-api/fern/pull/3342\r\ + \n* build(deps): bump golang.org/x/mod from 0.16.0 to 0.17.0 in /generators/go\ + \ by @dependabot in https://github.com/fern-api/fern/pull/3341\r\n* build(deps):\ + \ bump golang.org/x/tools from 0.19.0 to 0.20.0 in /generators/go by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3340\r\n* build(deps-dev): bump vite\ + \ from 5.1.3 to 5.2.8 by @dependabot in https://github.com/fern-api/fern/pull/3339\r\ + \n* fix: allow lists and sets to be complex query params by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3343\r\n* Update README to point\ + \ to the latest generators by @armandobelardo in https://github.com/fern-api/fern/pull/3344\r\ + \n* fix: commit .mock in ts-sdk by @mscolnick in https://github.com/fern-api/fern/pull/3345\r\ + \n* feat: generated jest tests by @mscolnick in https://github.com/fern-api/fern/pull/3267\r\ + \n* (fix): misc edits to csharp client generation by @dsinghvi in https://github.com/fern-api/fern/pull/3335\r\ + \n* improvement: upgrade ts-sdk, ts-express to IR37 by @mscolnick in https://github.com/fern-api/fern/pull/3347\r\ + \n* feat: add api summary markdown pages by @abvthecity in https://github.com/fern-api/fern/pull/3350\r\ + \n* feat: hidden, skipurlslug, and icon by @abvthecity in https://github.com/fern-api/fern/pull/3352\r\ + \n* (feat): setup root and sub client instantiations by @dsinghvi in https://github.com/fern-api/fern/pull/3351\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.31...0.20.0-rc0\r\ + \n* (chore): changelog dates are ready based on mdx title by @dsinghvi in https://github.com/fern-api/fern/pull/3354\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.31...0.20.0" + type: chore + createdAt: "2024-04-10" + irVersion: 37 + version: 0.20.0 +- changelogEntry: + - summary: "## What's Changed\r\n* revert: python generator version 0.13.2 by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3316\r\n* break: release python generator\ + \ 1.x by @armandobelardo in https://github.com/fern-api/fern/pull/3312\r\n*\ + \ fix: force pydantic.v1 only if pydantic v2, this is needed due to a p\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3318\r\n* feat:\ + \ add flag to disable Pydantic validation and keep extra fields on the Pydantic\ + \ model by @armandobelardo in https://github.com/fern-api/fern/pull/3311\r\n\ + * fix: do not try to generate the version file if we're not generating \u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3320\r\n* fix:\ + \ write skipping validation code the same as before to keep new lines by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3321\r\n* (chore): bump csharp sdk\ + \ generator version by @dsinghvi in https://github.com/fern-api/fern/pull/3322\r\ + \n* (feat, csharp): generate subclient files by @dsinghvi in https://github.com/fern-api/fern/pull/3325\r\ + \n* (fix): misc c# fixes by @dsinghvi in https://github.com/fern-api/fern/pull/3326\r\ + \n* (fix): csharp generator handles property and field level conflicts by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3327\r\n* (fix): remove str enum\ + \ from c# by @dsinghvi in https://github.com/fern-api/fern/pull/3328\r\n* fix:\ + \ fix pydantic skip validation by @armandobelardo in https://github.com/fern-api/fern/pull/3324\r\ + \n* (feature): Generate snippets locally by @amckinney in https://github.com/fern-api/fern/pull/3323\r\ + \n* (fix): send multipart upload property descriptions when registering docs\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3333\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.19.30...0.19.31-rc0" + type: chore + createdAt: "2024-04-05" + irVersion: 37 + version: 0.19.31 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): send auth prefix to docs by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3314\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.19.29...0.19.30" + type: chore + createdAt: "2024-04-03" + irVersion: 37 + version: 0.19.30 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature): Add retainOriginalCasing option to\ + \ TypeScript generators by @amckinney in https://github.com/fern-api/fern/pull/3310\r\ + \n* (feature): Implement pagination by @amckinney in https://github.com/fern-api/fern/pull/3304\r\ + \n* fix: revert to one ci file in python by @armandobelardo in https://github.com/fern-api/fern/pull/3237\r\ + \n* (fix): Authorization header schemes aren't truncated by @amckinney in https://github.com/fern-api/fern/pull/3313\r\ + \n* (fix): pass through correct maven url by @dsinghvi in https://github.com/fern-api/fern/pull/3315\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.28...0.19.29" + type: chore + createdAt: "2024-04-03" + irVersion: 37 + version: 0.19.29 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.27...0.19.28" + type: chore + createdAt: "2024-04-02" + irVersion: 37 + version: 0.19.28 +- changelogEntry: + - summary: + "## What's Changed\r\n* (chore): no icon tabs by @dsinghvi in https://github.com/fern-api/fern/pull/3309\r\ + \n* fix: allow for specifying x-fern-examples as the yaml schema, not jus\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3308\r\n\r\n\r\ + \n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.26...0.19.27" + type: chore + createdAt: "2024-04-02" + irVersion: 37 + version: 0.19.27 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): fern docs use horizontal tabs by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3307\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.19.25...0.19.26" + type: chore + createdAt: "2024-04-01" + irVersion: 37 + version: 0.19.26 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement: allow header auth extension to specify\ + \ auth prefix by @armandobelardo in https://github.com/fern-api/fern/pull/3303\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.24...0.19.25" + type: chore + createdAt: "2024-04-01" + irVersion: 37 + version: 0.19.25 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): allow specifying license in publish metadata\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3292\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.19.22...0.19.24" + type: chore + createdAt: "2024-03-29" + irVersion: 37 + version: 0.19.24 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.24-rc2...0.19.24-rc3" + type: chore + createdAt: "2024-03-29" + irVersion: 37 + version: 0.19.24-rc3 +- changelogEntry: + - summary: "## What's Changed\r\n* chore(docs): alphabetize docs components in the\ + \ navigation sidebar by @abvthecity in https://github.com/fern-api/fern/pull/3278\r\ + \n* fix: generate examples for multipart-form by @abvthecity in https://github.com/fern-api/fern/pull/3253\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.23...0.19.24-rc2" + type: chore + createdAt: "2024-03-29" + irVersion: 37 + version: 0.19.24-rc2 +- changelogEntry: + - summary: "## What's Changed\r\n* [(fix): openapi importer ignores duplicate enum\ + \ names](https://github.com/fern-api/fern/commit/6473f3269e31ad896aecc70c03149094ecd9679c)\ + \ by @dsinghvi\r\n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.23...0.19.24-rc1" + type: chore + createdAt: "2024-03-29" + irVersion: 37 + version: 0.19.24-rc1 +- changelogEntry: + - summary: "## What's Changed\r\n* chore(docs): alphabetize docs components in the\ + \ navigation sidebar by @abvthecity in https://github.com/fern-api/fern/pull/3278\r\ + \n* fix: generate examples for multipart-form by @abvthecity in https://github.com/fern-api/fern/pull/3253\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.23...0.19.24-rc0" + type: chore + createdAt: "2024-03-29" + irVersion: 37 + version: 0.19.24-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore): introduce to plumb through display\ + \ name by @dsinghvi in https://github.com/fern-api/fern/pull/3290\r\n\r\n\r\n\ + **Full Changelog**: https://github.com/fern-api/fern/compare/0.19.22...0.19.23" + type: chore + createdAt: "2024-03-29" + irVersion: 37 + version: 0.19.23 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): use display names for services by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3289\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.19.21...0.19.22" + type: chore + createdAt: "2024-03-28" + irVersion: 37 + version: 0.19.22 +- changelogEntry: + - summary: "## What's Changed\r\n* feat: API navigation overrides by @abvthecity\ + \ in https://github.com/fern-api/fern/pull/3205\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.19.20...0.19.21" + type: chore + createdAt: "2024-03-28" + irVersion: 37 + version: 0.19.21 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement, python: add __version__ variable\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3262\r\n* (docs):\ + \ update fern cli commands docs by @minaelee in https://github.com/fern-api/fern/pull/3215\r\ + \n* build(deps-dev): bump eslint-plugin-react from 7.31.10 to 7.34.1 by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3264\r\n* build(deps): bump github.com/fern-api/generator-exec-go\ + \ from 0.0.679 to 0.0.694 in /generators/go by @dependabot in https://github.com/fern-api/fern/pull/3263\r\ + \n* (docs): add requirements and installation instructions to fern CLI overview\ + \ by @minaelee in https://github.com/fern-api/fern/pull/3269\r\n* (docs): preface\ + \ all internal links with learn/ by @minaelee in https://github.com/fern-api/fern/pull/3270\r\ + \n* build(deps): bump tar and @types/tar by @dependabot in https://github.com/fern-api/fern/pull/3266\r\ + \n* build(deps-dev): bump sass from 1.71.0 to 1.72.0 by @dependabot in https://github.com/fern-api/fern/pull/3265\r\ + \n* (fix): resolve fern check failures due to invalid enum name overrides and\ + \ complex query params by @omarrida in https://github.com/fern-api/fern/pull/3268\r\ + \n* (docs): additional internal link updates by @minaelee in https://github.com/fern-api/fern/pull/3275\r\ + \n* build(deps): bump express from 4.18.2 to 4.19.2 by @dependabot in https://github.com/fern-api/fern/pull/3271\r\ + \n* (docs): start react components docs by @minaelee in https://github.com/fern-api/fern/pull/3276\r\ + \n* (docs): run vale linter on PR to fern/docs/pages/ by @minaelee in https://github.com/fern-api/fern/pull/3274\r\ + \n* fix: make map mutable for adding environment variables by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3280\r\n* improvement: default literal\ + \ values for unions by @armandobelardo in https://github.com/fern-api/fern/pull/3283\r\ + \n* (fix): Maps are complex query params by @amckinney in https://github.com/fern-api/fern/pull/3285\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.19...0.19.20" + type: chore + createdAt: "2024-03-27" + irVersion: 37 + version: 0.19.20 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): docs for `optionalImplementation` use\ + \ the right key by @dsinghvi in https://github.com/fern-api/fern/pull/3254\r\ + \n* (fix): support schema references in OpenAPI that aren't just Schema Ids\ + \ by @omarrida in https://github.com/fern-api/fern/pull/3259\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.19.18...0.19.19" + type: chore + createdAt: "2024-03-25" + irVersion: 37 + version: 0.19.19 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: update python defaults to be the user provided\ + \ number and not th\u2026 by @armandobelardo in https://github.com/fern-api/fern/pull/3248\r\ + \n* fix depth check to prevent max call stack exceeded issue by @omarrida in\ + \ https://github.com/fern-api/fern/pull/3247\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.19.17...0.19.18" + type: chore + createdAt: "2024-03-23" + irVersion: 37 + version: 0.19.18 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): fix typo in writing license by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3245\r\n* (internal): consolidate\ + \ GeneratorNotificationService implementations by @omarrida in https://github.com/fern-api/fern/pull/3235\r\ + \n* (feature): merge x-codeSamples with x-fern-examples by @abvthecity in https://github.com/fern-api/fern/pull/3246\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.16...0.19.17" + type: chore + createdAt: "2024-03-22" + irVersion: 37 + version: 0.19.17 +- changelogEntry: + - summary: "## What's Changed\r\n* (docs): document full slug override in front\ + \ matter by @minaelee in https://github.com/fern-api/fern/pull/3219\r\n* fix:\ + \ create a pom config for publishing by @armandobelardo in https://github.com/fern-api/fern/pull/3243\r\ + \n* \U0001F926: update final sonatype reference to allow staging url by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3244\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.19.16-rc0...0.19.16" + type: chore + createdAt: "2024-03-21" + irVersion: 37 + version: 0.19.16 +- changelogEntry: + - summary: "## What's Changed\r\n* fix, java: make gpg publish script executable\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3236\r\n* (docs):\ + \ update links due to recent docs changes by @minaelee in https://github.com/fern-api/fern/pull/3233\r\ + \n* fix: java publishing - wrap the multiline secret in quotes to perserv\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3239\r\n* fix:\ + \ update to the staging sonatype url for signing by @armandobelardo in https://github.com/fern-api/fern/pull/3240\r\ + \n* fix: update java registry in cli too by @armandobelardo in https://github.com/fern-api/fern/pull/3242\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.14...0.19.15" + type: chore + createdAt: "2024-03-21" + irVersion: 37 + version: 0.19.15 +- changelogEntry: + - summary: + "## What's Changed\r\n* (feature): sdk endpoint by @dsinghvi in https://github.com/fern-api/fern/pull/3197\r\ + \n* feat: add in gpg signing for gradle publish by @armandobelardo in https://github.com/fern-api/fern/pull/3195\r\ + \n* FER-970: Improve performance in by reducing reliance on async behavior and\ + \ lazy dynamic imports by @omarrida in https://github.com/fern-api/fern/pull/3206\r\ + \n* (fix): ts sdk doesn't support response property by @dsinghvi in https://github.com/fern-api/fern/pull/3208\r\ + \n* (internal): `seed` runs whenever `seed.yml` config changes by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3209\r\n* fix: fullSlug implementation\ + \ uses the wrong filepath structure by @abvthecity in https://github.com/fern-api/fern/pull/3210\r\ + \n* (docs): remove $ sign from bash codeblocks content by @minaelee in https://github.com/fern-api/fern/pull/3194\r\ + \n* add background-image docs by @minaelee in https://github.com/fern-api/fern/pull/3211\r\ + \n* build(deps-dev): bump @ts-morph/common from 0.21.0 to 0.23.0 by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3202\r\n* build(deps-dev): bump eslint-plugin-tailwindcss\ + \ from 3.14.2 to 3.15.1 by @dependabot in https://github.com/fern-api/fern/pull/3201\r\ + \n* build(deps): bump github.com/fern-api/generator-exec-go from 0.0.622 to\ + \ 0.0.679 in /generators/go by @dependabot in https://github.com/fern-api/fern/pull/3199\r\ + \n* (feat): set `ir-version` override when running generators by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3212\r\n* bump fern version by @minaelee\ + \ in https://github.com/fern-api/fern/pull/3214\r\n* improvement: allow ruby\ + \ and python to take in byte streams by @armandobelardo in https://github.com/fern-api/fern/pull/3207\r\ + \n* improvement: use AnyStr to keep intellisense for enums but allow forw\u2026\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3216\r\n* (fix):\ + \ Handle optional multipart references by @amckinney in https://github.com/fern-api/fern/pull/3218\r\ + \n* (fix): update generator config deserialization logic in OpenAPI generator\ + \ by @omarrida in https://github.com/fern-api/fern/pull/3224\r\n* (internal):\ + \ document syntax highlighting by @abvthecity in https://github.com/fern-api/fern/pull/3220\r\ + \n* (chore): Simplify heading for `max height` in a code block by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3225\r\n* (chore): rename `syntax\ + \ highlighting` to `code snippets` by @dsinghvi in https://github.com/fern-api/fern/pull/3226\r\ + \n* (docs): move `searchbar` to top to create more space by @dsinghvi in https://github.com/fern-api/fern/pull/3227\r\ + \n* fix: add signature to the local zod schema as well by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3228\r\n\r\n## New Contributors\r\n\ + * @omarrida made their first contribution in https://github.com/fern-api/fern/pull/3206\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.13...0.19.14-rc3" + type: chore + createdAt: "2024-03-21" + irVersion: 37 + version: 0.19.14 +- changelogEntry: + - summary: + "## What's Changed\r\n* (feature): sdk endpoint by @dsinghvi in https://github.com/fern-api/fern/pull/3197\r\ + \n* feat: add in gpg signing for gradle publish by @armandobelardo in https://github.com/fern-api/fern/pull/3195\r\ + \n* FER-970: Improve performance in by reducing reliance on async behavior and\ + \ lazy dynamic imports by @omarrida in https://github.com/fern-api/fern/pull/3206\r\ + \n* (fix): ts sdk doesn't support response property by @dsinghvi in https://github.com/fern-api/fern/pull/3208\r\ + \n* (internal): `seed` runs whenever `seed.yml` config changes by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3209\r\n* fix: fullSlug implementation\ + \ uses the wrong filepath structure by @abvthecity in https://github.com/fern-api/fern/pull/3210\r\ + \n* (docs): remove $ sign from bash codeblocks content by @minaelee in https://github.com/fern-api/fern/pull/3194\r\ + \n* add background-image docs by @minaelee in https://github.com/fern-api/fern/pull/3211\r\ + \n* build(deps-dev): bump @ts-morph/common from 0.21.0 to 0.23.0 by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3202\r\n* build(deps-dev): bump eslint-plugin-tailwindcss\ + \ from 3.14.2 to 3.15.1 by @dependabot in https://github.com/fern-api/fern/pull/3201\r\ + \n* build(deps): bump github.com/fern-api/generator-exec-go from 0.0.622 to\ + \ 0.0.679 in /generators/go by @dependabot in https://github.com/fern-api/fern/pull/3199\r\ + \n\r\n## New Contributors\r\n* @omarrida made their first contribution in https://github.com/fern-api/fern/pull/3206\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.13...0.19.14-rc0" + type: chore + createdAt: "2024-03-19" + irVersion: 37 + version: 0.19.14-rc0 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: tab slug override should be passed to FDR\ + \ by @abvthecity in https://github.com/fern-api/fern/pull/3198\r\n* fix: python\ + \ retry wrapper leverages the right types by @armandobelardo in https://github.com/fern-api/fern/pull/3204\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.12...0.19.13" + type: chore + createdAt: "2024-03-18" + irVersion: 37 + version: 0.19.13 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): unit tests for python now run successfully\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3187\r\n* (improvement):\ + \ allow x-fern-sdk-group-name to be a list by @mscolnick in https://github.com/fern-api/fern/pull/3196\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.11...0.19.12" + type: chore + createdAt: "2024-03-18" + irVersion: 37 + version: 0.19.12 +- changelogEntry: + - summary: "## What's Changed\r\n* chore: bump versions of public python sdk to\ + \ produce unit tests by @armandobelardo in https://github.com/fern-api/fern/pull/3179\r\ + \n* fix: small fix for python sdk gen by @armandobelardo in https://github.com/fern-api/fern/pull/3181\r\ + \n* chore: remove webpack from ts generators by @mscolnick in https://github.com/fern-api/fern/pull/3180\r\ + \n* build(deps): bump follow-redirects from 1.15.5 to 1.15.6 by @dependabot\ + \ in https://github.com/fern-api/fern/pull/3178\r\n* fix: Fix code-samples deserialization\ + \ from openapi-overrides.yml by @mscolnick in https://github.com/fern-api/fern/pull/3170\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.10...0.19.11" + type: chore + createdAt: "2024-03-15" + irVersion: 37 + version: 0.19.11 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: add in envvar scanning for more than bearer\ + \ auth by @armandobelardo in https://github.com/fern-api/fern/pull/3176\r\n\ + * fixing unit tests by @armandobelardo in https://github.com/fern-api/fern/pull/3168\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.9...0.19.10" + type: chore + createdAt: "2024-03-15" + irVersion: 37 + version: 0.19.10 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): make sure that deep object query params\ + \ are reverse migrated t\u2026 by @dsinghvi in https://github.com/fern-api/fern/pull/3172\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.8...0.19.9" + type: chore + createdAt: "2024-03-13" + irVersion: 37 + version: 0.19.9 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: run seed for ruby-seed by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3167\r\n* (fix): getReferencedMarkdownFiles\ + \ should ignore http/https links by @abvthecity in https://github.com/fern-api/fern/pull/3169\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.7...0.19.8" + type: chore + createdAt: "2024-03-13" + irVersion: 37 + version: 0.19.8 +- changelogEntry: + - summary: "## What's Changed\r\n* feat: init c# playground by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3142\r\n* build(deps-dev): bump eslint-plugin-tailwindcss\ + \ from 3.13.0 to 3.13.1 by @dependabot in https://github.com/fern-api/fern/pull/2946\r\ + \n* (chore): consolidate configuration into single package by @dsinghvi in https://github.com/fern-api/fern/pull/3141\r\ + \n* (feature): fern check catches invalid mdx files in docs by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3145\r\n* (feature): convert markdown\ + \ references to slug if possible by @dsinghvi in https://github.com/fern-api/fern/pull/3146\r\ + \n* fix: do not add auto-example if one exists by @armandobelardo in https://github.com/fern-api/fern/pull/3147\r\ + \n* (fix): migration depends on published coordinate by @dsinghvi in https://github.com/fern-api/fern/pull/3143\r\ + \n* import float as unknown from openapi spec by @buie in https://github.com/fern-api/fern/pull/3144\r\ + \n* chore: add polling to feature spec by @armandobelardo in https://github.com/fern-api/fern/pull/3068\r\ + \n* build(deps): bump golang.org/x/tools from 0.18.0 to 0.19.0 in /generators/go\ + \ by @dependabot in https://github.com/fern-api/fern/pull/3151\r\n* build(deps):\ + \ bump github.com/fern-api/generator-exec-go from 0.0.609 to 0.0.622 in /generators/go\ + \ by @dependabot in https://github.com/fern-api/fern/pull/3150\r\n* (feature):\ + \ implement fileUpload and bytes type conversion to FDR by @abvthecity in https://github.com/fern-api/fern/pull/3158\r\ + \n* feat, python: add snippet-based testing to Python SDKs by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3102\r\n* (fix): enable SSO on preview\ + \ URLs by @abvthecity in https://github.com/fern-api/fern/pull/3160\r\n* (fix):\ + \ Go snippets handle unknown examples by @amckinney in https://github.com/fern-api/fern/pull/3163\r\ + \n* (fix): update IR migration gates for Python SDK by @dsinghvi in https://github.com/fern-api/fern/pull/3164\r\ + \n\r\n## New Contributors\r\n* @buie made their first contribution in https://github.com/fern-api/fern/pull/3144\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.6...0.19.7-rc0" + type: chore + createdAt: "2024-03-13" + irVersion: 37 + version: 0.19.7 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): parse frontmatter before registering docs\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3140\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.19.5...0.19.6" + type: chore + createdAt: "2024-03-10" + irVersion: 37 + version: 0.19.6 +- changelogEntry: + - summary: "## What's Changed\r\n* (feat, cli): add autogenerated examples for the\ + \ fern definition by @armandobelardo in https://github.com/fern-api/fern/pull/3114\r\ + \n* (fix, cli): don't require a schema to exist under `application/octet-stream`\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3137\r\n\r\n\r\ + \n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.4...0.19.5" + type: chore + createdAt: "2024-03-10" + irVersion: 37 + version: 0.19.5 +- changelogEntry: + - summary: "## What's Changed\r\n* feat, python: allow extra fields not specified\ + \ in model to come through by @armandobelardo in https://github.com/fern-api/fern/pull/3131\r\ + \n* (fix): `x-fern-streaming` wont duplicate referenced requests causing collision\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3136\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.19.3...0.19.4" + type: chore + createdAt: "2024-03-09" + irVersion: 36 + version: 0.19.4 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, typescript): SDK generator appropriately\ + \ imports `node-fetch` by @dsinghvi in https://github.com/fern-api/fern/pull/3130\r\ + \n* fix: accent-primary regression (and move color validation to fern check)\ + \ by @abvthecity in https://github.com/fern-api/fern/pull/3132\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.19.2...0.19.3" + type: chore + createdAt: "2024-03-08" + irVersion: 36 + version: 0.19.3 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): OpenAPI importer reads `deprecated: true`\ + \ on operation objects by @dsinghvi in https://github.com/fern-api/fern/pull/3129\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.1...0.19.2" + type: chore + createdAt: "2024-03-08" + irVersion: 36 + version: 0.19.2 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): detect file object in OpenAPI and ignore\ + \ content type by @dsinghvi in https://github.com/fern-api/fern/pull/3128\r\n\ + \r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.0...0.19.1" + type: chore + createdAt: "2024-03-08" + irVersion: 36 + version: 0.19.1 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, typescript): serialize optional deep object\ + \ query params correctly in the TypeScript SDK by @dsinghvi in https://github.com/fern-api/fern/pull/3071\r\ + \n* fix, ruby: Ensure the name passed into the `X-Fern-SDK-Name` header is the\ + \ name of the gem, not the client class by @armandobelardo in https://github.com/fern-api/fern/pull/3073\r\ + \n* (fix, typescript): sdk code snippets dont render empty dicts for parameters\ + \ with default values by @dsinghvi in https://github.com/fern-api/fern/pull/3074\r\ + \n* (chore): Refactor Pagination IR to support offset by @amckinney in https://github.com/fern-api/fern/pull/3072\r\ + \n* (chore, internal): move `docs-config` to use local typescript sdk gen by\ + \ @abvthecity in https://github.com/fern-api/fern/pull/3047\r\n* (feature, beta):\ + \ support reading `changelog` dir from api directory by @dsinghvi in https://github.com/fern-api/fern/pull/3075\r\ + \n* docs: multiple site layout and page updates by @minaelee in https://github.com/fern-api/fern/pull/3052\r\ + \n* docs: overview diagram newer version by @dannysheridan in https://github.com/fern-api/fern/pull/3076\r\ + \n* docs: use new overview diagram image by @dannysheridan in https://github.com/fern-api/fern/pull/3077\r\ + \n* docs: add info on new icon component by @minaelee in https://github.com/fern-api/fern/pull/3079\r\ + \n* docs: update availability documentation by @minaelee in https://github.com/fern-api/fern/pull/3078\r\ + \n* (feature): leverage OpenAPI extension `x-tags` for schemas by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3081\r\n* fix: make express generator\ + \ respect it's version while publishing by @armandobelardo in https://github.com/fern-api/fern/pull/3084\r\ + \n* fix, nit: update the name of the GH workflow step to match by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3085\r\n* fix: address recursive\ + \ loop in example gen with a max depth and lookback by @armandobelardo in https://github.com/fern-api/fern/pull/3086\r\ + \n* (internal): stop running eslint by @dsinghvi in https://github.com/fern-api/fern/pull/3087\r\ + \n* (chore): upgrade mrlint and reenable eslint by @dsinghvi in https://github.com/fern-api/fern/pull/3088\r\ + \n* fix: add missing ruby dependencies to ensure rubocop can install by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3090\r\n* fix, ts: leverage the full\ + \ package path for `reference.md` by @armandobelardo in https://github.com/fern-api/fern/pull/3083\r\ + \n* (feature): Add option to disable OpenAPI example generation by @amckinney\ + \ in https://github.com/fern-api/fern/pull/3091\r\n* (ts, feature): introduce\ + \ custom config for `tolerateRepublish` to re publish npm versions by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3093\r\n* improvement, python: swap\ + \ to literals instead of enums by @armandobelardo in https://github.com/fern-api/fern/pull/3082\r\ + \n* docs: add new sdks quickstarts and update docs.yml by @minaelee in https://github.com/fern-api/fern/pull/3095\r\ + \n* docs: update feb 2024 changelog by @minaelee in https://github.com/fern-api/fern/pull/3092\r\ + \n* (fix): republish python seed container by @dsinghvi in https://github.com/fern-api/fern/pull/3098\r\ + \n* (fix): support generating correct code snippets when extending base client\ + \ in python by @dsinghvi in https://github.com/fern-api/fern/pull/3097\r\n*\ + \ (fix): Importer handles adding imports from api.yml by @dsinghvi in https://github.com/fern-api/fern/pull/3100\r\ + \n* fix: build seed docker multiplatform by @armandobelardo in https://github.com/fern-api/fern/pull/3099\r\ + \n* (feature): allow overriding type for global headers by @dsinghvi in https://github.com/fern-api/fern/pull/3101\r\ + \n* feat, python: add in max_retries with exponential backoff by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3096\r\n* fix, python: use docstrings\ + \ instead of descriptions by @armandobelardo in https://github.com/fern-api/fern/pull/3108\r\ + \n* chore: cache docker builds in github actions by @mscolnick in https://github.com/fern-api/fern/pull/3104\r\ + \n* chore: migrate to Vitest by @mscolnick in https://github.com/fern-api/fern/pull/3103\r\ + \n* (feature): Go supports simpler unions by @amckinney in https://github.com/fern-api/fern/pull/3111\r\ + \n* fix: strip trailing slash from environments list by @abvthecity in https://github.com/fern-api/fern/pull/3109\r\ + \n* chore: stop checking equality when merging files by @armandobelardo in https://github.com/fern-api/fern/pull/3112\r\ + \n* improvement: add additional reserved words to python by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3116\r\n* docs: add titles and descs\ + \ by @minaelee in https://github.com/fern-api/fern/pull/3113\r\n* Revert \"\ + chore: migrate to Vitest\" by @dsinghvi in https://github.com/fern-api/fern/pull/3118\r\ + \n* (chore): fix our tests by @dsinghvi in https://github.com/fern-api/fern/pull/3119\r\ + \n* (fix): `fern generate --docs` doesn't reupload duplicate files preventing\ + \ 503s by @dsinghvi in https://github.com/fern-api/fern/pull/3120\r\n* (feature):\ + \ introduce more layout options for docs configuration by @abvthecity in https://github.com/fern-api/fern/pull/3115\r\ + \n* docs: update components docs by @minaelee in https://github.com/fern-api/fern/pull/3117\r\ + \n* (beta): introduce new api configuration in generators.yml by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3121\r\n* (fix): `mergeWith` actually\ + \ merges with incoming spec by @dsinghvi in https://github.com/fern-api/fern/pull/3124\r\ + \n* build(deps): bump jose from 4.11.2 to 4.15.5 by @dependabot in https://github.com/fern-api/fern/pull/3123\r\ + \n\r\n## New Contributors\r\n* @mscolnick made their first contribution in https://github.com/fern-api/fern/pull/3104\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.18.5...0.19.0" + type: chore + createdAt: "2024-03-07" + irVersion: 36 + version: 0.19.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): `mergeWith` actually merges with incoming\ + \ spec by @dsinghvi in https://github.com/fern-api/fern/pull/3124\r\n\r\n\r\n\ + **Full Changelog**: https://github.com/fern-api/fern/compare/0.19.0-rc8...0.19.0-rc9" + type: chore + createdAt: "2024-03-07" + irVersion: 36 + version: 0.19.0-rc9 +- changelogEntry: + - summary: "## What's Changed\r\n* (improvement, python): add additional reserved\ + \ words to python by @armandobelardo in https://github.com/fern-api/fern/pull/3116\r\ + \n* (chore): fix our tests by @dsinghvi in https://github.com/fern-api/fern/pull/3119\r\ + \n* (fix): `fern generate --docs` doesn't reupload duplicate files preventing\ + \ 503s by @dsinghvi in https://github.com/fern-api/fern/pull/3120\r\n* (feature):\ + \ introduce more layout options for docs configuration by @abvthecity in https://github.com/fern-api/fern/pull/3115\r\ + \n* (beta): introduce new api configuration in generators.yml by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3121\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.19.0-rc7...0.19.0-rc8" + type: chore + createdAt: "2024-03-07" + irVersion: 36 + version: 0.19.0-rc8 +- changelogEntry: + - summary: "## What's Changed\r\n* chore: stop checking equality when merging files\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3112\r\n\r\n\r\ + \n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.0-rc6...0.19.0-rc7" + type: chore + createdAt: "2024-03-05" + irVersion: 36 + version: 0.19.0-rc7 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, python): use docstrings instead of descriptions\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3108\r\n* (feature,\ + \ go): Supports simpler unions by @amckinney in https://github.com/fern-api/fern/pull/3111\r\ + \n* (fix, cli): strip trailing slash from environments list by @abvthecity in\ + \ https://github.com/fern-api/fern/pull/3109\r\n* (feature): allow overriding\ + \ type for global headers by @dsinghvi in https://github.com/fern-api/fern/pull/3101\r\ + \n* (feat, python): add in max_retries with exponential backoff by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3096\r\n* (ts, feature): introduce\ + \ custom config for `tolerateRepublish` to re publish npm versions by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3093\r\n* (improvement, python):\ + \ swap to literals instead of enums by @armandobelardo in https://github.com/fern-api/fern/pull/3082\r\ + \n* (fix, python): support generating correct code snippets when extending base\ + \ client in python by @dsinghvi in https://github.com/fern-api/fern/pull/3097\r\ + \n* (fix): Importer handles adding imports from api.yml by @dsinghvi in https://github.com/fern-api/fern/pull/3100\r\ + \n* (fix, ruby): add missing ruby dependencies to ensure rubocop can install\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3090\r\n* (fix,\ + \ ts): leverage the full package path for `reference.md` by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3083\r\n* (feature): Add option to\ + \ disable OpenAPI example generation by @amckinney in https://github.com/fern-api/fern/pull/3091\r\ + \n* (feature): leverage OpenAPI extension `x-tags` for schemas by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3081\r\n* (fix, typescript): serialize\ + \ optional deep object query params correctly in the TypeScript SDK by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3071\r\n* (fix, ruby): Ensure the\ + \ name passed into the `X-Fern-SDK-Name` header is the name of the gem, not\ + \ the client class by @armandobelardo in https://github.com/fern-api/fern/pull/3073\r\ + \n* (fix, typescript): sdk code snippets dont render empty dicts for parameters\ + \ with default values by @dsinghvi in https://github.com/fern-api/fern/pull/3074\r\ + \n* (chore): Refactor Pagination IR to support offset by @amckinney in https://github.com/fern-api/fern/pull/3072\r\ + \n* (chore, internal): move `docs-config` to use local typescript sdk gen by\ + \ @abvthecity in https://github.com/fern-api/fern/pull/3047\r\n* (feature, beta):\ + \ support reading `changelog` dir from api directory by @dsinghvi in https://github.com/fern-api/fern/pull/3075\r\ + \n* (fix, express): make express generator respect it's version while publishing\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3084\r\n* (fix):\ + \ address recursive loop in example gen with a max depth and lookback by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3086\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.19.0-rc3...0.18.5\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.19.0-rc4...0.19.0-rc5\r\ + \n\r\n## New Contributors\r\n* @mscolnick made their first contribution in https://github.com/fern-api/fern/pull/3104\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.19.0-rc5...0.19.0-rc6" + type: chore + createdAt: "2024-03-05" + irVersion: 36 + version: 0.19.0-rc6 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore, go): Release fern-go-sdk 0.17.0 by @amckinney\ + \ in https://github.com/fern-api/fern/pull/3066\r\n* (feature, go): supports\ + \ multiple files in upload by @amckinney in https://github.com/fern-api/fern/pull/3070\r\ + \n* (feature, ts): deep object query parameter serialization by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/3060\r\n* (chore): CLI supports providing\ + \ IR v33 to TypeScript generators by @dsinghvi in https://github.com/fern-api/fern/pull/3060\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.18.4...0.18.5" + type: chore + createdAt: "2024-02-27" + irVersion: 36 + version: 0.18.5 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): OpenAPI/AsyncAPI importer handles invalid\ + \ datetime examples by @dsinghvi in https://github.com/fern-api/fern/pull/3056\r\ + \n* (fix): ensure we apply audience-based filtering to examples as well by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3043\r\n* (feat, fern): allow headers\ + \ to specify their envvar as well by @armandobelardo in https://github.com/fern-api/fern/pull/3061\r\ + \n* (feat, python): support envvar scanning for headers by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3064\r\n\r\n## New Contributors\r\n\ + * @Danwakeem made their first contribution in https://github.com/fern-api/fern/pull/3057\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.18.3...0.18.4" + type: chore + createdAt: "2024-02-26" + irVersion: 36 + version: 0.18.4 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix, java): leverage callTimeout instead of\ + \ readTimeout for RequestOptions timeout configuration by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/3031\r\n* (fix, java): Address NPE for\ + \ RequestOptions with new timeout feature by @armandobelardo in https://github.com/fern-api/fern/pull/3053\r\ + \n* (fix, go): Snippets for optional primitive aliases are accurate by @amckinney\ + \ in https://github.com/fern-api/fern/pull/3050\r\n* (fix, python): move from\ + \ lists to sequences when using lists in function signatures by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3040\r\n* (fix, java) Use safe name\ + \ to generate discriminator wrapper class by @kikones34 in https://github.com/fern-api/fern/pull/2961\r\ + \n* (fix, python): just use jsonable_encoder and remove .value from enum references\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3044\r\n* (fix,\ + \ python): fix envvars scanning by updating the ApiError usage by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/3046\r\n* (feature): OpenAPI importer\ + \ attempts to use tag order to render endpoints if possible by @dsinghvi in\ + \ https://github.com/fern-##\r\n* (improvement, python): make optional fields\ + \ not required by default by @armandobelardo in https://github.com/fern-api/fern/pull/3041\r\ + \n* (feature): Add pagination (IRv35) by @amckinney in https://github.com/fern-api/fern/pull/2985\r\ + \n* (feature): support asyncapi examples via `x-fern-examples` by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3042\r\n* (feature): generate default\ + \ examples for WebSocket Sessions by @dsinghvi in https://github.com/fern-api/fern/pull/3039\r\ + \n* (fix): fern check no longer throws when an undiscriminated union is a list\ + \ of primitives by @dsinghvi in https://github.com/fern-api/fern/pull/3055\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.18.2...0.18.3-rc0\r\ + \n\r\n## New Contributors\r\n* @kikones34 made their first contribution in https://github.com/fern-api/fern/pull/2961\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.18.3-rc1...0.18.3-rc2" + type: chore + createdAt: "2024-02-26" + irVersion: 35 + version: 0.18.3 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature, python): introduce feature flag to\ + \ simplify imports in python and remove the nested `resources` directory by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/3029\r\n* (chore, internal):\ + \ move `openapi-ir` to use local typescript sdk codegen by @dsinghvi in https://github.com/fern-api/fern/pull/3033\r\ + \n* (docs): external sidebar links, filled navbar button, tab slug overrides\ + \ by @abvthecity in https://github.com/fern-api/fern/pull/3034\r\n* (feature):\ + \ Add Go snippet generation by @amckinney in https://github.com/fern-api/fern/pull/3035\r\ + \n* (feature): Importer brings in Websocket Channels from `AsyncAPI` by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3037\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.18.1...0.18.2" + type: chore + createdAt: "2024-02-22" + irVersion: 34 + version: 0.18.2 +- changelogEntry: + - summary: "## What's Changed\r\n* docs: define fern as a toolkit by @dannysheridan\ + \ in https://github.com/fern-api/fern/pull/2974\r\n* (feature): introduce websocket\ + \ channel into fern definition by @dsinghvi in https://github.com/fern-api/fern/pull/2975\r\ + \n* (fix): `fern write-overrides` uses summary to generate method name if no\ + \ operation id and tag are present by @dsinghvi in https://github.com/fern-api/fern/pull/2976\r\ + \n* (python, feat): add in request options to python by @armandobelardo in https://github.com/fern-api/fern/pull/2926\r\ + \n* (fix): postman collection is published appropriately by @dsinghvi in https://github.com/fern-api/fern/pull/2978\r\ + \n* (internal): add websocket to IR by @dsinghvi in https://github.com/fern-api/fern/pull/2981\r\ + \n* (internal): register websocket schemas with fdr by @dsinghvi in https://github.com/fern-api/fern/pull/2983\r\ + \n* python, fix: revert regressions in writing circular references by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/2988\r\n* (typescript): always use\ + \ `node-fetch` when in Node.js by @dsinghvi in https://github.com/fern-api/fern/pull/2989\r\ + \n* (typescript): Fetcher supports sending bytes in request body in `0.11.4`\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2991\r\n* (feature):\ + \ make sure casing overrides take affect by @dsinghvi in https://github.com/fern-api/fern/pull/2992\r\ + \n* (fix): IR generation respects casing overrides by @dsinghvi in https://github.com/fern-api/fern/pull/2994\r\ + \n* chore, ruby: release the ruby generators to include IR compatibility fix\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/2995\r\n* (fix):\ + \ `x-fern-webhook` respects sdk method and group name by @dsinghvi in https://github.com/fern-api/fern/pull/2996\r\ + \n* (feat, openapi): add global header aliasing by @armandobelardo in https://github.com/fern-api/fern/pull/2990\r\ + \n* feat, ts: add in a reference generator class by @armandobelardo in https://github.com/fern-api/fern/pull/2998\r\ + \n* improvement: tweaks to how we write references by @armandobelardo in https://github.com/fern-api/fern/pull/3001\r\ + \n* (feat, java): add timeout to request options by @armandobelardo in https://github.com/fern-api/fern/pull/2973\r\ + \n* chore: nest Go changelog within ./go/sdk by @dannysheridan in https://github.com/fern-api/fern/pull/3004\r\ + \n* docs: delete unused pages by @minaelee in https://github.com/fern-api/fern/pull/3008\r\ + \n* docs: fix broken link by @minaelee in https://github.com/fern-api/fern/pull/3007\r\ + \n* (chore, internal): speed up seed tests by using custom runner by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3005\r\n* (chore, internal): introduce\ + \ telemetry for seed CLI by @dsinghvi in https://github.com/fern-api/fern/pull/3009\r\ + \n* (fix): optional enum body parameters now pass check by @dsinghvi in https://github.com/fern-api/fern/pull/2914\r\ + \n* (fix, python): literals are properly accepted as `query`, `path`, `header`,\ + \ inlined body and referenced body parameters by @dsinghvi in https://github.com/fern-api/fern/pull/3012\r\ + \n* improvement: allow files to be arrays within the IR by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/2993\r\n* (fix, typescript): core.Stream\ + \ is browser compatible by @dsinghvi in https://github.com/fern-api/fern/pull/3017\r\ + \n* (chore, internal): setup browser playground for ts generator by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3019\r\n* build(deps): bump golang.org/x/tools\ + \ from 0.17.0 to 0.18.0 in /generators/go by @dependabot in https://github.com/fern-api/fern/pull/3015\r\ + \n* (typescript, release): release browser compatible streaming in `0.11.5`\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/3022\r\n* (internal)\ + \ rename Websocket to WebSocket and bump fdr by @abvthecity in https://github.com/fern-api/fern/pull/3018\r\ + \n* feats, ruby: add in idempotency headers and improve enum and union implementations\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3020\r\n* improvement,\ + \ python: update python file type to be more reflective or HTTPX types and allow\ + \ lists of files by @armandobelardo in https://github.com/fern-api/fern/pull/3010\r\ + \n* build(deps): bump axios from 0.27.2 to 0.28.0 by @dependabot in https://github.com/fern-api/fern/pull/3024\r\ + \n* fix: websocket inline jsonExample and ir-to-fdr path by @abvthecity in https://github.com/fern-api/fern/pull/3026\r\ + \n* improvement, seed: reduce size of seed containers and speed up python and\ + \ java tests by @armandobelardo in https://github.com/fern-api/fern/pull/3011\r\ + \n* feature, python: allow for users to define custom exports from __init__.py\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/3025\r\n* build(deps):\ + \ bump github.com/fern-api/generator-exec-go from 0.0.574 to 0.0.600 in /generators/go\ + \ by @dependabot in https://github.com/fern-api/fern/pull/3021\r\n* (java, fix):\ + \ file upload endpoints compile when determining mime type by @dsinghvi in https://github.com/fern-api/fern/pull/3027\r\ + \n* (fix): a single enum with x-fern-enum is not turned into a literal by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/3028\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.18.0...0.18.1" + type: chore + createdAt: "2024-02-21" + irVersion: 34 + version: 0.18.1 +- changelogEntry: + - summary: "## What's Changed\r\n* (chore, ruby): release the ruby generators to\ + \ include IR compatibility fix by @armandobelardo in https://github.com/fern-api/fern/pull/2995\r\ + \n* (cli, fix): `x-fern-webhook` respects sdk method and group name by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2996\r\n* (cli, feature): IR generation\ + \ respects casing overrides by @dsinghvi in https://github.com/fern-api/fern/pull/2994\r\ + \n* (python, feat): add in request options to python by @armandobelardo in https://github.com/fern-api/fern/pull/2926\r\ + \n* (typescript): always use `node-fetch` when in Node.js by @dsinghvi in https://github.com/fern-api/fern/pull/2989\r\ + \n* (typescript): Fetcher supports sending bytes in request body in `0.11.4`\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2991\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.18.0...0.18.0-rc0\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.18.1-rc1...0.18.1-rc2" + type: chore + createdAt: "2024-02-16" + irVersion: 33 + version: 0.18.1-rc2 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): handle `optional` multipart file upload\ + \ parameters by @armandobelardo in https://github.com/fern-api/fern/pull/2964\r\ + \n* (break): sever base paths are no longer pre-pended to endpoint URLs in OpenAPI\ + \ Parser by @dsinghvi in https://github.com/fern-api/fern/pull/2972\r\n\r\n\r\ + \n**Full Changelog**: https://github.com/fern-api/fern/compare/0.17.10...0.18.0" + type: chore + createdAt: "2024-02-14" + irVersion: 33 + version: 0.18.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (typescript): typescript generator forwards runtime\ + \ information via `X-Fern-Runtime` header by @dsinghvi in https://github.com/fern-api/fern/pull/2962\r\ + \n* (python): Remove literals from the function signature by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/2952\r\n* (fix): TypeScript SDK generator\ + \ no longer enables `noUnusedParameters` in tsconfg.json by @dsinghvi in https://github.com/fern-api/fern/pull/2968\r\ + \n* (python): Remove support for Python 3.7 by @armandobelardo in https://github.com/fern-api/fern/pull/2967\r\ + \n* (fix): OpenAPI importer appropriately handles custom json content types\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2971\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.17.9...0.17.10" + type: chore + createdAt: "2024-02-13" + irVersion: 33 + version: 0.17.10 +- changelogEntry: + - summary: "## What's Changed\r\n* (internal): initialize csharp AST by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2938\r\n* (feature): go generator\ + \ supports whitelabelling by @dsinghvi in https://github.com/fern-api/fern/pull/2953\r\ + \n* (feature): OpenAPI importer handles extending undiscriminated unions if\ + \ they are objects by @dsinghvi in https://github.com/fern-api/fern/pull/2956\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.17.8...0.17.9" + type: chore + createdAt: "2024-02-13" + irVersion: 33 + version: 0.17.9 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature): support whitelabeling SDKs by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2928\r\n* (feature): css + js + measure\ + \ img size by @abvthecity in https://github.com/fern-api/fern/pull/2872api/fern/pull/2937\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.17.7...0.17.8" + type: chore + createdAt: "2024-02-11" + irVersion: 33 + version: 0.17.8 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): read nuget output mode\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.17.3...0.17.5" + type: chore + createdAt: "2024-02-09" + irVersion: 33 + version: 0.17.7 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): only opt in go and ruby to capitalize\ + \ initialisms by @dsinghvi in https://github.com/fern-api/fern/pull/2925\r\n\ + \r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.17.3...0.17.4" + type: chore + createdAt: "2024-02-09" + irVersion: 33 + version: 0.17.4 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement: add better numbering support for\ + \ snakecasing when smartCasing is enabled by @armandobelardo in https://github.com/fern-api/fern/pull/2921\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.17.1...0.17.3" + type: chore + createdAt: "2024-02-09" + irVersion: 33 + version: 0.17.3 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): misc improvements to OpenAPI example generation\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2916\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.17.1...0.17.2" + type: chore + createdAt: "2024-02-08" + irVersion: 33 + version: 0.17.2 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): OpenAPI overrides replaces list of primitives\ + \ but merges list of objects by @dsinghvi in https://github.com/fern-api/fern/pull/2910\r\ + \n* (fix): OpenAPI overrides replaces list of primitives but merges list of\ + \ objects by @dsinghvi in https://github.com/fern-api/fern/pull/2910\r\n* (fix):\ + \ use brightness not luminance to flip the color theme by @abvthecity in https://github.com/fern-api/fern/pull/2912\r\ + \napi/fern/pull/2915\r\n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.17.0...0.17.1" + type: chore + createdAt: "2024-02-07" + irVersion: 33 + version: 0.17.1 +- changelogEntry: + - summary: "- **break**: The OpenAPI importer now considers the `title` field when\ + \ generating a schema name. It only considers this field if there is no whitespace\ + \ and only contains alphabetic characters. We're constantly trying to improve\ + \ Fern to generate as idiomatic code as possible and naming schemas correctly\ + \ is a huge part of that. \r\n \r\n By upgrading the Fern CLI to a `0.17.x`\ + \ version, any SDKs with the following OpenAPI would receive compile breaks\ + \ b/c the object would be renamed as `Bar`.\r\n ```yaml\r\n Foo: \r\n \ + \ title: Bar\r\n type: object\r\n ```\r\n" + type: chore + createdAt: "2024-02-07" + irVersion: 33 + version: 0.17.0 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature): additional layout options for docs\ + \ by @abvthecity in https://github.com/fern-api/fern/pull/2781\r\n* (feature):\ + \ `x-fern-examples` extension in OpenAPI operation by @abvthecity in https://github.com/fern-api/fern/pull/2856\r\ + \n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.43...0.16.44-rc0\r\ + \n* (java): java sdk, model and spring generators now support boolean literals\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2887\r\n* fixes: \U0001F48E\ + \ Ruby: Fix typos, imports and several other papercuts within SDK generation\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/2868\r\n* fix:\ + \ Ruby: fix version header and file write location by @armandobelardo in https://github.com/fern-api/fern/pull/2889\r\ + \n* fix: ruby: support deeply nested objects correctly by @armandobelardo in\ + \ https://github.com/fern-api/fern/pull/2895\r\n* chore: allow releasing RCs\ + \ through Actions by @armandobelardo in https://github.com/fern-api/fern/pull/2896\r\ + \n* fix: update the dev release workflow to leverage full commit history by\ + \ @armandobelardo in https://github.com/fern-api/fern/pull/2897\r\n* additional\ + \ config options by @abvthecity in https://github.com/fern-api/fern/pull/2781\r\ + \n* improvement: update readme to expose fastapi configs by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/2901\r\n* fix: ruby: address potential\ + \ naming conflicts within SDK by @armandobelardo in https://github.com/fern-api/fern/pull/2902\r\ + \n* fix: Ruby: ensure services always have a name by @armandobelardo in https://github.com/fern-api/fern/pull/2903\r\ + \n* fix: improve handling color config for dark vs light themes by @abvthecity\ + \ in https://github.com/fern-api/fern/pull/2904\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.16.43...0.16.44-rc1" + type: chore + createdAt: "2024-02-06" + irVersion: 32 + version: 0.16.44-rc1 +- changelogEntry: + - summary: + "## What's Changed\r\n* (ruby): 0.0.1 Release by @armandobelardo in https://github.com/fern-api/fern/pull/2858\r\ + \n* (java): java sdk generator supports idempotency headers by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/2884\r\n* (cli): `x-fern-streaming`\ + \ respects extensions on stream property by @dsinghvi in https://github.com/fern-api/fern/pull/2853\r\ + \n* (cli): list overrides win over OpenAPI and do not get combined by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2854\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.43-rc0...0.16.43-rc1\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.43-rc1...0.16.43-rc2" + type: chore + createdAt: "2024-02-04" + irVersion: 32 + version: 0.16.43 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement: TypeScript SDK steps in quickstart\ + \ by @dannysheridan in https://github.com/fern-api/fern/pull/2829\r\n* fix:\ + \ increase python generator recursion depth to allow for deeply nested examples\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/2825\r\n* fix:\ + \ OpenAPI importer respects `x-examples` key by @dsinghvi in https://github.com/fern-api/fern/pull/2845\r\ + \n* (fix): Add support for custom code samples by @abvthecity in https://github.com/fern-api/fern/pull/2842\r\ + \n* (fix): OpenAPI importer brings in example names by @dsinghvi in https://github.com/fern-api/fern/pull/2847\r\ + \n* (fix): `fern write-definition` does not remove markdown formatting by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2849\r\n* (feature): introduce `x-fern-resolutions`\ + \ extension by @dsinghvi in https://github.com/fern-api/fern/pull/2844\r\n\r\ + \n## New Contributors\r\n* @abvthecity made their first contribution in https://github.com/fern-api/fern/pull/2842\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.41...0.16.42" + type: chore + createdAt: "2024-02-01" + irVersion: 32 + version: 0.16.42 +- changelogEntry: + - summary: "## What's Changed\r\n* (feature): OpenAPI importer supports format `json-string`\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2827\r\n ```yaml\r\n\ + \ MySchema: \r\n type: striing\r\n format: json-string # <---- OpenAPI\ + \ importer handles this\r\n ```\r\n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.40...0.16.41" + type: chore + createdAt: "2024-01-29" + irVersion: 32 + version: 0.16.41 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): add a `disable-example` flag for generators\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2826\r\n ```yaml\r\n\ + \ generators: \r\n - name: ...\r\n version: ...\r\n disable-examples:\ + \ true # A temporary workaround while we iron out example deserialization bugs\ + \ in python\r\n ```\r\n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.39...0.16.40" + type: chore + createdAt: "2024-01-29" + irVersion: 32 + version: 0.16.40 +- changelogEntry: + - summary: "## What's Changed\r\n* (release): support scanning env variable for\ + \ auth in python sdk generator 0.8.1 by @dsinghvi in https://github.com/fern-api/fern/pull/2811\r\ + \n* (feature): introduce nuget ouptut location by @dsinghvi in https://github.com/fern-api/fern/pull/2812\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.38...0.16.39" + type: chore + createdAt: "2024-01-26" + irVersion: 32 + version: 0.16.39 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): OpenAPI importer uses the `value` field\ + \ when looking at `examples` by @dsinghvi in https://github.com/fern-api/fern/pull/2803\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.37...0.16.38" + type: chore + createdAt: "2024-01-26" + irVersion: 32 + version: 0.16.38 +- changelogEntry: + - summary: "## What's Changed\r\n* (fix): Allow Ruby generator to work on IRv32\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/2668\r\n* (chore):\ + \ Go generators use IRv32 by @amckinney in https://github.com/fern-api/fern/pull/2672\r\ + \n* (fix): python sdk sends enum value for inlined requests by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/2793\r\n* (release): 0.8.0 of python-sdk\ + \ generator by @dsinghvi in https://github.com/fern-api/fern/pull/2795\r\n*\ + \ (fix): OpenAPI importer query parameters always generate valid names by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2801\r\n* (fix): OpenAPI importer\ + \ example generation skips object query params by @dsinghvi in https://github.com/fern-api/fern/pull/2800\r\ + \n\r\n## New Contributors\r\n* @SK-Sam made their first contribution in https://github.com/fern-api/fern/pull/2687\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.36...0.16.37" + type: chore + createdAt: "2024-01-25" + irVersion: 32 + version: 0.16.37 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: CLI supports running Ruby sdk + model\ + \ generator by @armandobelardo in https://github.com/fern-api/fern/pull/2570\r\ + \n* fix: OpenAPI importer adds variables accordingly by @dsinghvi in https://github.com/fern-api/fern/pull/2667\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.35...0.16.36" + type: chore + createdAt: "2024-01-19" + irVersion: 32 + version: 0.16.36 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI importer supports union examples\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2653\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.16.34...0.16.35" + type: chore + createdAt: "2024-01-18" + irVersion: 32 + version: 0.16.35 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI importer supports generating examples\ + \ for `unknown` by @dsinghvi in https://github.com/fern-api/fern/pull/2624\r\ + \n* fix: auto generation of primitive examples by @dsinghvi in https://github.com/fern-api/fern/pull/2625\r\ + \n* fix: misc fixes to OpenAPI example generation by @dsinghvi in https://github.com/fern-api/fern/pull/2630\r\ + \n* fix: `getAllProperties` visits references by @dsinghvi in https://github.com/fern-api/fern/pull/2631\r\ + \n* fix: OpenAPI importer uses generated names for aliases by @dsinghvi in https://github.com/fern-api/fern/pull/2632\r\ + \n* fix: inlined component schemas are added to __package__.yml by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2633\r\n* fix: OpenAPI importer handles\ + \ property conflicts from grandparents by @dsinghvi in https://github.com/fern-api/fern/pull/2637\r\ + \n* fix: OpenAPI importer replaces schemas that start with numbers with alphabetic\ + \ notation by @dsinghvi in https://github.com/fern-api/fern/pull/2638\r\n* fix:\ + \ upgrade fiddle sdk to `0.0.386` so that license generation works by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2643\r\n* fix: OpenAPI importer removes\ + \ redundant path from environment by @dsinghvi in https://github.com/fern-api/fern/pull/2650\r\ + \n* fix: OpenAPI importer doesn't extend aliased schemas that have a property\ + \ conflict by @dsinghvi in https://github.com/fern-api/fern/pull/2651\r\n* fix:\ + \ OpenAPI importer doesn't set name override for nested key value pair by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2652\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.16.33...0.16.34" + type: chore + createdAt: "2024-01-17" + irVersion: 32 + version: 0.16.34 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: add `fern mock` command by @amckinney\ + \ in https://github.com/fern-api/fern/pull/2618\r\n* feature: OpenAPI importer\ + \ looks at `examples` property by @dsinghvi in https://github.com/fern-api/fern/pull/2621\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.32...0.16.33" + type: chore + createdAt: "2024-01-15" + irVersion: 32 + version: 0.16.33 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI importer handles converting boolean\ + \ enums @dsinghvi in https://github.com/fern-api/fern/pull/2616\r\n\r\n\r\n\ + **Full Changelog**: https://github.com/fern-api/fern/compare/0.16.31...0.16.32" + type: chore + createdAt: "2024-01-13" + irVersion: 32 + version: 0.16.32 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI importer visits nested `allOf` when\ + \ inlined by @dsinghvi in https://github.com/fern-api/fern/pull/2615\r\n\r\n\ + \r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.30...0.16.31" + type: chore + createdAt: "2024-01-12" + irVersion: 32 + version: 0.16.31 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: allow specifying OpenAPI overrides in\ + \ generators.yml by @dsinghvi in https://github.com/fern-api/fern/pull/2613\r\ + \n ```yaml\r\n # generators.yml \r\n openapi: \r\n openapi-overrides:\ + \ \r\n ```\r\n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.29...0.16.30" + type: chore + createdAt: "2024-01-12" + irVersion: 32 + version: 0.16.30 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI importer supports reading `x-fern-sdk-return-value`\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2610\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.16.28...0.16.29" + type: chore + createdAt: "2024-01-12" + irVersion: 32 + version: 0.16.29 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI importer adds common server path\ + \ to endpoint path by @dsinghvi in https://github.com/fern-api/fern/pull/2603\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.27...0.16.28" + type: chore + createdAt: "2024-01-11" + irVersion: 32 + version: 0.16.28 +- changelogEntry: + - summary: "## What's Changed\r\n* test: Add test for file upload with query params\ + \ by @amckinney in https://github.com/fern-api/fern/pull/2441\r\n* test: Replace\ + \ /bin/bash with /bin/sh by @amckinney in https://github.com/fern-api/fern/pull/2595\r\ + \n* docs: update quickstart.mdx by @minaelee in https://github.com/fern-api/fern/pull/2596\r\ + \n* fix: send descriptions for union base properties when generating docs by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/2601\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.16.25...0.16.26" + type: chore + createdAt: "2024-01-11" + irVersion: 32 + version: 0.16.27 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI importer creates inline request\ + \ schemas for singular allOf by @dsinghvi in https://github.com/fern-api/fern/pull/2591\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.24...0.16.25" + type: chore + createdAt: "2024-01-10" + irVersion: 32 + version: 0.16.25 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI converter uses literals when anyOf\ + \ has inlined enums by @dsinghvi in https://github.com/fern-api/fern/pull/2589\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.23...0.16.24" + type: chore + createdAt: "2024-01-10" + irVersion: 32 + version: 0.16.24 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: make `generators.yml` optional if no generators\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2585\r\n\r\n## New Contributors\r\ + \n* @minaelee made their first contribution in https://github.com/fern-api/fern/pull/2567\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.22...0.16.23" + type: chore + createdAt: "2024-01-09" + irVersion: 32 + version: 0.16.23 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: handle error declaration conflicts in OpenAPI\ + \ importer by @dsinghvi in https://github.com/fern-api/fern/pull/2550\r\n\r\n\ + \r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.21...0.16.22" + type: chore + createdAt: "2024-01-01" + irVersion: 32 + version: 0.16.22 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI importer handles null `anyOf` with\ + \ more than 3 variants by @dsinghvi in https://github.com/fern-api/fern/pull/2549\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.20...0.16.21" + type: chore + createdAt: "2024-01-01" + irVersion: 32 + version: 0.16.21 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: `push` mode for GitHub repository by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/2546\r\n ```yaml\r\n \ + \ # generators.yml\r\n - name: fernapi/fern-python-sdk\r\n ...\r\n github:\ + \ \r\n mode: push\r\n repository: owner/repo\r\n branch: # optional\ + \ branch, if omitted uses the default channel \r\n ```\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.16.19...0.16.20" + type: chore + createdAt: "2023-12-29" + irVersion: 32 + version: 0.16.20 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.17...0.16.19" + type: chore + createdAt: "2023-12-23" + irVersion: 32 + version: 0.16.19 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: openapi importer generates oauth 2 scopes\ + \ enum by @dsinghvi in https://github.com/fern-api/fern/pull/2540\r\n\r\n\r\n\ + **Full Changelog**: https://github.com/fern-api/fern/compare/0.16.16...0.16.17" + type: chore + createdAt: "2023-12-23" + irVersion: 32 + version: 0.16.17 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: respect audiences on inlined request bodies\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2535\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.16.15...0.16.16" + type: chore + createdAt: "2023-12-22" + irVersion: 32 + version: 0.16.16 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: unknown types should be treated as optional\ + \ when validating examples by @dsinghvi in https://github.com/fern-api/fern/pull/2532\r\ + \n* fix: `write-definition` writes to hidden folder by @dsinghvi in https://github.com/fern-api/fern/pull/2533\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.14...0.16.15" + type: chore + createdAt: "2023-12-22" + irVersion: 32 + version: 0.16.15 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: `fern write-definition` writes out api\ + \ dependencies by @dsinghvi in https://github.com/fern-api/fern/pull/2531\r\n\ + \r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.13...0.16.14" + type: chore + createdAt: "2023-12-22" + irVersion: 32 + version: 0.16.14 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: support property level audiences by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/2526\r\n* feature: openapi\ + \ importer supports importing property level audiences by @dsinghvi in https://github.com/fern-api/fern/pull/2528\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.12...0.16.13" + type: chore + createdAt: "2023-12-21" + irVersion: 32 + version: 0.16.13 +- changelogEntry: + - summary: "## What's Changed\r\n* internal: seed accepts path to api directory\ + \ for custom fixture by @dsinghvi in https://github.com/fern-api/fern/pull/2516\r\ + \n* fix: fern python generators rely on ir v31 by @dsinghvi in https://github.com/fern-api/fern/pull/2517\r\ + \n* feature: run prettier on doc strings by @dsinghvi in https://github.com/fern-api/fern/pull/2508\r\ + \n* fix: use `JSON.stringify` when writing IR by @dsinghvi in https://github.com/fern-api/fern/pull/2511\r\ + \n* fix: OpenAPI importer handles self referencing schemas by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/2512\r\n* fix: handle explicit `null`\ + \ strings in OpenAPI schemas by @dsinghvi in https://github.com/fern-api/fern/pull/2514\r\ + \n* fix: `ResourceList` in fhir is an undiscriminated union with literal properties\ + \ by @armandobelardo in https://github.com/fern-api/fern/pull/2513\r\n* fix:\ + \ add `int`, `float`, and `complex` to python reserved words by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/2523\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.16.11...0.16.12" + type: chore + createdAt: "2023-12-20" + irVersion: 32 + version: 0.16.12 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI importer properly escapes examples\ + \ that start with $ sign by @dsinghvi in https://github.com/fern-api/fern/pull/2509\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.10...0.16.11" + type: chore + createdAt: "2023-12-18" + irVersion: 32 + version: 0.16.11 +- changelogEntry: + - summary: "## What's Changed\r\n* document: x-fern-server-name extension by @dannysheridan\ + \ in https://github.com/fern-api/fern/pull/2504\r\n* feature: add x-fern-parameter-name\ + \ extension by @amckinney in https://github.com/fern-api/fern/pull/2489\r\n\ + * chore: seed exits 1 if tests fail by @dsinghvi in https://github.com/fern-api/fern/pull/2505\r\ + \n* fix: x-fern-streaming can be used with x-fern-group-name by @amckinney in\ + \ https://github.com/fern-api/fern/pull/2488\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.16.9...0.16.10" + type: chore + createdAt: "2023-12-18" + irVersion: 32 + version: 0.16.10 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: improve `fern check` only logging errors\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2501\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.16.8...0.16.9" + type: chore + createdAt: "2023-12-17" + irVersion: 32 + version: 0.16.9 +- changelogEntry: + - summary: "## What's Changed\r\n* chore: run ci on forked PRs for contributors\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2494\r\n* internal:\ + \ seed only runs one container per script for all fixtures by @armandobelardo\ + \ in https://github.com/fern-api/fern/pull/2492\r\n* fix: typo in docs starter\ + \ example repo by @dannysheridan in https://github.com/fern-api/fern/pull/2496\r\ + \n* fix: header on quickstart page by @dannysheridan in https://github.com/fern-api/fern/pull/2497\r\ + \n* fix: `fern write-definition` doesn't throw on non-OpenAPI workspaces by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/2499\r\n* fix: `fern check`\ + \ logs `All checks passed` if no errors @dsinghvi in https://github.com/fern-api/fern/pull/2499\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.7...0.16.8" + type: chore + createdAt: "2023-12-17" + irVersion: 32 + version: 0.16.8 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: openapi importer correctly imports across\ + \ nested fern definition files by @dsinghvi in https://github.com/fern-api/fern/pull/2491\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.6...0.16.7" + type: chore + createdAt: "2023-12-14" + irVersion: 32 + version: 0.16.7 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: openapi importer properly detects json response\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2487\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.16.5...0.16.6" + type: chore + createdAt: "2023-12-13" + irVersion: 32 + version: 0.16.6 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI importer detects all possible `application/json`\ + \ request and response content types by @dsinghvi in https://github.com/fern-api/fern/pull/2486\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.4...0.16.5" + type: chore + createdAt: "2023-12-13" + irVersion: 32 + version: 0.16.5 +- changelogEntry: + - summary: "## What's Changed\r\n* internal: enable typescript code snippets in\ + \ fern docs by @dsinghvi in https://github.com/fern-api/fern/pull/2473\r\n*\ + \ internal: `generators.yml` in public-api by @dsinghvi in https://github.com/fern-api/fern/pull/2475\r\ + \n* document: API-wide global configs in api.yml by @dannysheridan in https://github.com/fern-api/fern/pull/2478\r\ + \n* fix: escape OpenAPI string examples that star with `$` by @dsinghvi in https://github.com/fern-api/fern/pull/2483\r\ + \n* fix: handle OpenAPI importer handles unions `type: [string, object]` by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/2483\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.16.3...0.16.4" + type: chore + createdAt: "2023-12-13" + irVersion: 32 + version: 0.16.4 +- changelogEntry: + - summary: "## What's Changed\r\n* improvement: openapi importer enum name generator\ + \ for like `>`, `<` , `<=`, `>=` by @dsinghvi in https://github.com/fern-api/fern/pull/2471\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.2...0.16.3" + type: chore + createdAt: "2023-12-11" + irVersion: 32 + version: 0.16.3 +- changelogEntry: + - summary: "## What's Changed\r\n* docs: show example of list by @dannysheridan\ + \ in https://github.com/fern-api/fern/pull/2464\r\n* docs: improve cli descriptions\ + \ by @dannysheridan in https://github.com/fern-api/fern/pull/2466\r\n* fix:\ + \ openapi importer enum generation is valid @dsinghvi in https://github.com/fern-api/fern/pull/2468\r\ + \n* fix: openapi importer request references generation is valid @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/2468\r\n* fix: introduce `fern openapi-ir`\ + \ for debugging @dsinghvi in https://github.com/fern-api/fern/pull/2468\r\n\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.16.1...0.16.2" + type: chore + createdAt: "2023-12-10" + irVersion: 32 + version: 0.16.2 +- changelogEntry: + - summary: "## What's Changed\r\n* test: introduce a test definition for optional\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2460\r\n* fix: aliases\ + \ with `x-fern-sdk-group-name` are stored in the right file by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/2461\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.16.0...0.16.1" + type: chore + createdAt: "2023-12-08" + irVersion: 32 + version: 0.16.1 +- changelogEntry: + - summary: "## What's Changed\r\n* docs: add docs quickstart by @dannysheridan in\ + \ https://github.com/fern-api/fern/pull/2456\r\n* docs: fix callout spacing\ + \ by @dannysheridan in https://github.com/fern-api/fern/pull/2457\r\n* docs:\ + \ example provided for path parameter by @dannysheridan in https://github.com/fern-api/fern/pull/2458\r\ + \n* *feature*: support `x-fern-sdk-group-name` on schemas by @dsinghvi in https://github.com/fern-api/fern/pull/2459\r\ + \n **NOTE** The OpenAPI importer was drastically modified, so be careful upgrading\ + \ to `0.16.0` and report any issues!\r\n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.18...0.16.0" + type: chore + createdAt: "2023-12-08" + irVersion: 32 + version: 0.16.0 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: overrides from `x-fern-overrides-filepath`\ + \ file win on tie by @dsinghvi in https://github.com/fern-api/fern/pull/2455\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.17...0.15.18" + type: chore + createdAt: "2023-12-07" + irVersion: 32 + version: 0.15.18 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: support overlaying extensions using\ + \ `x-fern-overrides-filepath` by @dsinghvi in https://github.com/fern-api/fern/pull/2452\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.16...0.15.17" + type: chore + createdAt: "2023-12-07" + irVersion: 32 + version: 0.15.17 +- changelogEntry: + - summary: "## What's Changed\r\n* docs: Add screenshots to availability page by\ + \ @dannysheridan in https://github.com/fern-api/fern/pull/2448\r\n* feature:\ + \ OpenAPI supports `application/pdf` content-type by @amckinney in https://github.com/fern-api/fern/pull/2450\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.15...0.15.16" + type: chore + createdAt: "2023-12-06" + irVersion: 32 + version: 0.15.16 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: validate responses that are imported correctly\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2447\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.15.14...0.15.15" + type: chore + createdAt: "2023-12-06" + irVersion: 32 + version: 0.15.15 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.13...0.15.14" + type: chore + createdAt: "2023-12-06" + irVersion: 32 + version: 0.15.14 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: OpenAPI importer supports `audio/mpeg`\ + \ content type by @dsinghvi in https://github.com/fern-api/fern/pull/2446\r\n\ + \r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.12...0.15.13" + type: chore + createdAt: "2023-12-06" + irVersion: 32 + version: 0.15.13 +- changelogEntry: + - summary: "## What's Changed\r\n* internal: seed supports configurable ouptut mode\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2430\r\n* internal:\ + \ add examples to literal-headers test definition by @amckinney in https://github.com/fern-api/fern/pull/2437\r\ + \n* internal: seed fixtures are dynamic by @amckinney in https://github.com/fern-api/fern/pull/2440\r\ + \n* documentation: broken links in quickstart by @dannysheridan in https://github.com/fern-api/fern/pull/2444\r\ + \n* feature: use tag order to set `navigation` in fern definition by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2445\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.15.11...0.15.12" + type: chore + createdAt: "2023-12-06" + irVersion: 32 + version: 0.15.12 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: use terminal link to render clickable\ + \ docs URL by @dannysheridan in https://github.com/fern-api/fern/pull/2391\r\ + \n* docs: Explain how SDKs and Docs use audiences by @dannysheridan in https://github.com/fern-api/fern/pull/2411\r\ + \n* feature: send property level availability information to docs by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2420\r\n* feature: support undiscriminated\ + \ union examples in ir by @dsinghvi in https://github.com/fern-api/fern/pull/2425\r\ + \n* feature: support x-fern-ignore at the schema level by @dsinghvi in https://github.com/fern-api/fern/pull/2428\r\ + \n* fix: correctly validate referenced examples that are being imported by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2429\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.15.10...0.15.11" + type: chore + createdAt: "2023-12-04" + irVersion: 32 + version: 0.15.11 +- changelogEntry: + - summary: "## What's Changed\r\n* seed: generators can be tested with different\ + \ output versions by @amckinney in https://github.com/fern-api/fern/pull/2401\r\ + \n* seed: support optional compile commands by @amckinney in https://github.com/fern-api/fern/pull/2409\r\ + \n* fix: example properties for imported types are properly serialized by @dsinghvi\ + \ in https://github.com/fern-api/fern/pull/2407\r\n\r\n\r\n**Full Changelog**:\ + \ https://github.com/fern-api/fern/compare/0.15.9...0.15.10" + type: chore + createdAt: "2023-11-30" + irVersion: 31 + version: 0.15.10 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: properly convert examples of imported types\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2404\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.15.8...0.15.9" + type: chore + createdAt: "2023-11-30" + irVersion: 31 + version: 0.15.9 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: see docker logs when running `fern generate\ + \ --local` by @dsinghvi in https://github.com/fern-api/fern/pull/2400\r\n\r\n\ + \r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.7...0.15.8" + type: chore + createdAt: "2023-11-30" + irVersion: 31 + version: 0.15.8 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: compress fhir definition by having types\ + \ extend `BaseResource` by @dsinghvi in https://github.com/fern-api/fern/pull/2387\r\ + \n* docs: availability in Fern Definition by @dannysheridan in https://github.com/fern-api/fern/pull/2395\r\ + \n* fix: OpenAPI importer generates non-conflicting names for multipart file\ + \ upload endpoints by @dsinghvi in https://github.com/fern-api/fern/pull/2399\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.6...0.15.7" + type: chore + createdAt: "2023-11-30" + irVersion: 31 + version: 0.15.7 +- changelogEntry: + - summary: "## What's Changed\r\n* docs: how to control display order of your API\ + \ reference by @dsinghvi in https://github.com/fern-api/fern/pull/2366\r\n*\ + \ docs: .NET server code generator for C# by @dannysheridan in https://github.com/fern-api/fern/pull/2354\r\ + \n* docs: improve fern's readme.md by @dannysheridan in https://github.com/fern-api/fern/pull/2370\r\ + \n* docs: improve images in readme by @dannysheridan in https://github.com/fern-api/fern/pull/2371\r\ + \n* docs: improve readme image by @dannysheridan in https://github.com/fern-api/fern/pull/2372\r\ + \n* docs: add getting started to readme by @dannysheridan in https://github.com/fern-api/fern/pull/2380\r\ + \n* docs: update bug-report.md by @dannysheridan in https://github.com/fern-api/fern/pull/2375\r\ + \n* docs: file structure upon fern init by @dannysheridan in https://github.com/fern-api/fern/pull/2381\r\ + \n* fix: fern no longer fails to parse nested maps (`map>`)by @mmolash in https://github.com/fern-api/fern/pull/2369\r\n\r\n##\ + \ New Contributors\r\n* @mmolash made their first contribution in https://github.com/fern-api/fern/pull/2369\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.5...0.15.6" + type: chore + createdAt: "2023-11-28" + irVersion: 31 + version: 0.15.6 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: forward along global headers when registering\ + \ docs by @dsinghvi in https://github.com/fern-api/fern/pull/2358\r\n\r\n\r\n\ + **Full Changelog**: https://github.com/fern-api/fern/compare/0.15.4...0.15.5" + type: chore + createdAt: "2023-11-27" + irVersion: 31 + version: 0.15.5 +- changelogEntry: + - summary: "## What's Changed\r\n* chore: use correct URL for preview server by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/2322\r\n* fix: docs preview\ + \ server no longer has cors requirement by @dsinghvi in https://github.com/fern-api/fern/pull/2323\r\ + \n* Add test def for optional enum query param by @davidkonigsberg in https://github.com/fern-api/fern/pull/2317\r\ + \n* chore: migrate to github workflows by @dsinghvi in https://github.com/fern-api/fern/pull/2327\r\ + \n* chore: migrate documentation to core repo by @dsinghvi in https://github.com/fern-api/fern/pull/2328\r\ + \n* feature: add example docs by @dsinghvi in https://github.com/fern-api/fern/pull/2342\r\ + \n* Change 'let us know' link from email to issue by @zachkirsch in https://github.com/fern-api/fern/pull/2344\r\ + \n* fix: links to generators by making them exact urls by @dannysheridan in\ + \ https://github.com/fern-api/fern/pull/2346\r\n* feature: seed CLI runs compile\ + \ commands for verification by @dsinghvi in https://github.com/fern-api/fern/pull/2351\r\ + \n* Improvement: document using an enum name and value by @dannysheridan in\ + \ https://github.com/fern-api/fern/pull/2349\r\n* chore: test definition for\ + \ bearer auth with environment variable by @dsinghvi in https://github.com/fern-api/fern/pull/2353\r\ + \n* fix: resolve referenced examples for path parameters by @dsinghvi in https://github.com/fern-api/fern/pull/2356\r\ + \n\r\n## New Contributors\r\n* @davidkonigsberg made their first contribution\ + \ in https://github.com/fern-api/fern/pull/2317\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.3...0.15.4" + type: chore + createdAt: "2023-11-27" + irVersion: 31 + version: 0.15.4 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: migrate from registry-node to fdr-sdk by\ + \ @dsinghvi in https://github.com/fern-api/fern/pull/2313\r\n* build(deps):\ + \ bump @redocly/openapi-core from 1.4.0 to 1.4.1 by @dependabot in https://github.com/fern-api/fern/pull/2312\r\ + \n* build(deps): bump @fern-api/venus-api-sdk from 0.0.20-7-g6ea8dc4 to 0.0.36\ + \ by @dependabot in https://github.com/fern-api/fern/pull/2311\r\n* fix: docs\ + \ preview server returns the proper load docs by url response by @dsinghvi in\ + \ https://github.com/fern-api/fern/pull/2315\r\n* build(deps-dev): bump @types/swagger2openapi\ + \ from 7.0.0 to 7.0.4 by @dependabot in https://github.com/fern-api/fern/pull/2309\r\ + \n* feature: introduce `idempotency` configuration by @dsinghvi in https://github.com/fern-api/fern/pull/2302\r\ + \n* chore: add `idempotency-headers` to fern by @dsinghvi in https://github.com/fern-api/fern/pull/2318\r\ + \n* chore: typescript generators depend on ir v31 by @dsinghvi in https://github.com/fern-api/fern/pull/2320\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.2...0.15.3" + type: chore + createdAt: "2023-11-21" + irVersion: 31 + version: 0.15.3 +- changelogEntry: + - summary: "- **fix**: running `fern generate --local` with a `.fernignore` works + in Github Actions (@dsinghvi)" + type: chore + createdAt: "2023-11-20" + irVersion: 30 + version: 0.15.2 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.2-rc1...0.15.2-rc3" + type: chore + createdAt: "2023-11-20" + irVersion: 30 + version: 0.15.2-rc3 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.2-rc1...0.15.2-rc2" + type: chore + createdAt: "2023-11-20" + irVersion: 30 + version: 0.15.2-rc2 +- changelogEntry: + - summary: "**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.2-rc0...0.15.2-rc1" + type: chore + createdAt: "2023-11-20" + irVersion: 30 + version: 0.15.2-rc1 +- changelogEntry: + - summary: + "## What's Changed\r\n* upgrade json5 to `2.2.2` by @dsinghvi in https://github.com/fern-api/fern/pull/2304\r\ + \n* chore: remove wire verification by @dsinghvi in https://github.com/fern-api/fern/pull/2305\r\ + \n* chore: upgrade yaml to 2.3.3 by @dsinghvi in https://github.com/fern-api/fern/pull/2306\r\ + \n* fix: `fern generate --local` with `.fernignore` fails in Github Workflow\ + \ by @dsinghvi in https://github.com/fern-api/fern/pull/2307\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.15.1...0.15.2-rc0" + type: chore + createdAt: "2023-11-20" + irVersion: 30 + version: 0.15.2-rc0 +- changelogEntry: + - summary: "_It's been forever since we released a non release candidate!_\r\n\r\ + \n**Break**\r\n- The file structure of the Fern folder has now changed. If you\ + \ have a single API, your definition can live directly at the top-level. If\ + \ you have multiple, they will need to live in an apis folder. When you run\ + \ `fern upgrade` the directory structure will automatically be updated. " + type: chore + createdAt: "2023-11-20" + irVersion: 30 + version: 0.15.1 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: introduce `fern token` command to generate\ + \ `FERN_TOKEN` by @dsinghvi in https://github.com/fern-api/fern/pull/2295\r\n\ + \r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.0-rc87...0.15.0-rc88" + type: chore + createdAt: "2023-11-17" + irVersion: 30 + version: 0.15.0-rc88 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: non .fernignored files are deleted on successive\ + \ regeneration by @dsinghvi in https://github.com/fern-api/fern/pull/2294\r\n\ + \r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.0-rc84...0.15.0-rc85" + type: chore + createdAt: "2023-11-17" + irVersion: 30 + version: 0.15.0-rc87 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: `fern generate --local` no longer fails\ + \ if `.fernignore` is present and there are no new changes by @dsinghvi in https://github.com/fern-api/fern/pull/2291\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.0-rc83...0.15.0-rc84" + type: chore + createdAt: "2023-11-16" + irVersion: 30 + version: 0.15.0-rc84 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: default to service availability if endpoint\ + \ availability is not present by @dsinghvi in https://github.com/fern-api/fern/pull/2290\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.0-rc82...0.15.0-rc83" + type: chore + createdAt: "2023-11-16" + irVersion: 30 + version: 0.15.0-rc83 +- changelogEntry: + - summary: "## What's Changed\r\n* feature: introduce `x-fern-type` extension to\ + \ the OpenAPI spec by @dsinghvi in https://github.com/fern-api/fern/pull/2289\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.0-rc81...0.15.0-rc82" + type: chore + createdAt: "2023-11-16" + irVersion: 30 + version: 0.15.0-rc82 +- changelogEntry: + - summary: "## What's Changed\r\n* **Internal**: Add fern-python generator versions\ + \ for IRv30 by @amckinney in https://github.com/fern-api/fern/pull/2283\r\n\ + * **Internal**: Fix fern-java-model maven coordinates by @amckinney in https://github.com/fern-api/fern/pull/2284\r\ + \n* **Internal**: Generate fern-api/ir-go repository by @amckinney in https://github.com/fern-api/fern/pull/2285\r\ + \n* **Internal**: Set IRv29 version for TS and Java by @amckinney in https://github.com/fern-api/fern/pull/2286\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.0-rc80...0.15.0-rc81" + type: chore + createdAt: "2023-11-15" + irVersion: 30 + version: 0.15.0-rc81 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: dont compare root api files if dependency\ + \ has no endpoints by @dsinghvi in https://github.com/fern-api/fern/pull/2282\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.0-rc79...0.15.0-rc80" + type: chore + createdAt: "2023-11-15" + irVersion: 30 + version: 0.15.0-rc80 +- changelogEntry: + - summary: "## What's Changed\r\n* internal: Add more granular test definitions\ + \ by @amckinney in https://github.com/fern-api/fern/pull/2277\r\n* feature:\ + \ update fhir.yml and setup workflow for registration by @dsinghvi in https://github.com/fern-api/fern/pull/2280\r\ + \n* fix: register union base properties in docs by @dsinghvi in https://github.com/fern-api/fern/pull/2281\r\ + \n\r\n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.0-rc77...0.15.0-rc78" + type: chore + createdAt: "2023-11-15" + irVersion: 30 + version: 0.15.0-rc79 +- changelogEntry: + - summary: "- **feature**: mark `in-development` endpoints as `beta` in the generated + docs" + type: chore + createdAt: "2023-11-14" + irVersion: 29 + version: 0.15.0-rc75 +- changelogEntry: + - summary: "## What's Changed\r\n* **internal** Introduce IR version 30 for example\ + \ @amckinney in https://github.com/fern-api/fern/pull/2273\r\n\r\n\r\n**Full\ + \ Changelog**: https://github.com/fern-api/fern/compare/0.15.0-rc76...0.15.0-rc77" + type: chore + createdAt: "2023-11-14" + irVersion: 30 + version: 0.15.0-rc77 +- changelogEntry: + - summary: "## What's Changed\r\n* fix: OpenAPI importer handles parsing server\ + \ variables by @dsinghvi in https://github.com/fern-api/fern/pull/2275\r\n\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.15.0-rc75...0.15.0-rc76" + type: chore + createdAt: "2023-11-14" + irVersion: 29 + version: 0.15.0-rc76 +- changelogEntry: + - summary: Release 0.15.0-rc74 + type: chore + createdAt: "2023-11-09" + irVersion: 29 + version: 0.15.0-rc74 +- changelogEntry: + - summary: "- unblock ir-v28 generation" + type: chore + createdAt: "2023-11-09" + irVersion: 29 + version: 0.15.0-rc73 +- changelogEntry: + - summary: Release 0.15.0-rc72 + type: chore + createdAt: "2023-11-09" + irVersion: 29 + version: 0.15.0-rc72 +- changelogEntry: + - summary: "- CLI supports running typescript generators 0.8.1+ (@dsinghvi)" + type: chore + createdAt: "2023-11-09" + irVersion: 29 + version: 0.15.0-rc71 +- changelogEntry: + - summary: "- Support a `x-fern-streaming` extension in the OpenAPI importer (@amckinney)" + type: chore + createdAt: "2023-11-08" + irVersion: 28 + version: 0.15.0-rc70 +- changelogEntry: + - summary: _No user facing changes_ + type: chore + createdAt: "2023-11-03" + irVersion: 27 + version: 0.15.0-rc68 +- changelogEntry: + - summary: _No user facing changes_ + type: chore + createdAt: "2023-11-03" + irVersion: 27 + version: 0.15.0-rc67 +- changelogEntry: + - summary: "- **fix**: OpenAPI importer always uses tags to organize endpoints if + present (@dsinghvi)" + type: chore + createdAt: "2023-11-03" + irVersion: 27 + version: 0.15.0-rc66 +- changelogEntry: + - summary: _No user facing changes_ + type: chore + createdAt: "2023-11-02" + irVersion: 27 + version: 0.15.0-rc65 +- changelogEntry: + - summary: _No user facing changes_ + type: chore + createdAt: "2023-11-02" + irVersion: 27 + version: 0.15.0-rc64 +- changelogEntry: + - summary: _No user facing changes_ + type: chore + createdAt: "2023-11-01" + irVersion: 27 + version: 0.15.0-rc63 +- changelogEntry: + - summary: "- OpenAPI importer skips example generation if `allOf` examples are + undefined (@dsinghvi)" + type: chore + createdAt: "2023-11-01" + irVersion: 27 + version: 0.15.0-rc61 +- changelogEntry: + - summary: "- Filter out undefined schemas when reading AsyncAPI (@dsinghvi)" + type: chore + createdAt: "2023-11-01" + irVersion: 27 + version: 0.15.0-rc60 +- changelogEntry: + - summary: "fix: OpenAPI importer handles resolving property schema references (@dsinghvi)" + type: chore + createdAt: "2023-11-01" + irVersion: 27 + version: 0.15.0-rc59 +- changelogEntry: + - summary: "- Retrigger latest release (@dsinghvi)" + type: chore + createdAt: "2023-10-30" + irVersion: 27 + version: 0.15.0-rc57 +- changelogEntry: + - summary: "**fix**: AsyncAPI importer reads inlined message payloads (@dsinghvi)" + type: chore + createdAt: "2023-10-30" + irVersion: 27 + version: 0.15.0-rc56 +- changelogEntry: + - summary: "- **fix**: OpenAPI parser handles converting discriminated unions that + contain`allOf` references with the discriminant (@dsinghvi)" + type: chore + createdAt: "2023-10-30" + irVersion: 27 + version: 0.15.0-rc55 +- changelogEntry: + - summary: "- **feature**: OpenAPI importer supports resolving multi-file references + (@dsinghvi)" + type: chore + createdAt: "2023-10-30" + irVersion: 27 + version: 0.15.0-rc54 +- changelogEntry: + - summary: "- **feature**: OpenAPI importer supports `x-fern-header-variable-name` + to customize the header name in the SDK" + type: chore + createdAt: "2023-10-28" + irVersion: 27 + version: 0.15.0-rc53 +- changelogEntry: + - summary: "- **fix**: OpenAPI importer handles multiple header security schemes" + type: chore + createdAt: "2023-10-27" + irVersion: 27 + version: 0.15.0-rc52 +- changelogEntry: + - summary: "- **No user facing changes** - Seed testing CLI doesn't require generator + languages to support testing OpenAPI/Postman generators" + type: chore + createdAt: "2023-10-27" + irVersion: 27 + version: 0.15.0-rc51 +- changelogEntry: + - summary: "- Not a user facing change: IR for `property-response` uses correct + typeId (@dsinghvi)" + type: chore + createdAt: "2023-10-26" + irVersion: 27 + version: 0.15.0-rc50 +- changelogEntry: + - summary: "- Improve logging when `.fernignore` is present in directory (@dsinghvi) " + type: chore + createdAt: "2023-10-25" + irVersion: 27 + version: 0.15.0-rc49 +- changelogEntry: + - summary: "- Upgrade Go generator IR version (@amckinney) \r\n- `response-property`\ + \ validation rules now handle aliases (@amckinney) " + type: chore + createdAt: "2023-10-25" + irVersion: 27 + version: 0.15.0-rc48 +- changelogEntry: + - summary: "- Support `--custom fixture` in seed CLI for snapshot tests (@dsinghvi) " + type: chore + createdAt: "2023-10-24" + irVersion: 27 + version: 0.15.0-rc47 +- changelogEntry: + - summary: "- Support literal examples (@dsinghvi) " + type: chore + createdAt: "2023-10-20" + irVersion: 27 + version: 0.15.0-rc46 +- changelogEntry: + - summary: "- **fix**: OpenAPI importer removes global headers from example generation + (@dsinghvi) " + type: chore + createdAt: "2023-10-20" + irVersion: 27 + version: 0.15.0-rc45 +- changelogEntry: + - summary: "- OpenAPI example parser handles query params that are arrays (@dsinghvi) " + type: chore + createdAt: "2023-10-20" + irVersion: 27 + version: 0.15.0-rc44 +- changelogEntry: + - summary: "- Support reading examples from OpenAPI spec (@dsinghvi) " + type: chore + createdAt: "2023-10-20" + irVersion: 27 + version: 0.15.0-rc43 +- changelogEntry: + - summary: "- Support generating preview url when generating docs (@dsinghvi) " + type: chore + createdAt: "2023-10-15" + irVersion: 26 + version: 0.15.0-rc42 +- changelogEntry: + - summary: Release 0.15.0-rc40 + type: chore + createdAt: "2023-10-13" + irVersion: 26 + version: 0.15.0-rc40 +- changelogEntry: + - summary: "- Rerelease SDKs (@dsinghvi) " + type: chore + createdAt: "2023-10-13" + irVersion: 26 + version: 0.15.0-rc41 +- changelogEntry: + - summary: "- Support generating python snippets for documentation" + type: chore + createdAt: "2023-10-11" + irVersion: 26 + version: 0.15.0-rc39 +- changelogEntry: + - summary: "- Additional seed test definitions (@dsinghvi) " + type: chore + createdAt: "2023-10-10" + irVersion: 26 + version: 0.15.0-rc38 +- changelogEntry: + - summary: "- **fix**: delete existing output on local generation (@dsinghvi) " + type: chore + createdAt: "2023-10-08" + irVersion: 26 + version: 0.15.0-rc37 +- changelogEntry: + - summary: "- **fix**: seed CLI builds docker image (@dsinghvi) " + type: chore + createdAt: "2023-10-08" + irVersion: 26 + version: 0.15.0-rc36 +- changelogEntry: + - summary: "- fix seed examples to contain datetime with UTC timezone (@dsinghvi) " + type: chore + createdAt: "2023-10-08" + irVersion: 26 + version: 0.15.0-rc35 +- changelogEntry: + - summary: "- Fix: OpenAPI importer scans const fields when detecting discriminated + unions (@dsinghvi) " + type: chore + createdAt: "2023-10-06" + irVersion: 26 + version: 0.15.0-rc34 +- changelogEntry: + - summary: "- Read `const` values from OpenAPI spec (@dsinghvi) " + type: chore + createdAt: "2023-10-06" + irVersion: 26 + version: 0.15.0-rc33 +- changelogEntry: + - summary: "- Fix discriminated union parsing in AsyncAPI import (@dsinghvi) " + type: chore + createdAt: "2023-10-05" + irVersion: 26 + version: 0.15.0-rc32 +- changelogEntry: + - summary: "- Server side generators are tested with output mode local files (@dsinghvi) " + type: chore + createdAt: "2023-10-01" + irVersion: 26 + version: 0.15.0-rc31 +- changelogEntry: + - summary: "- Generator snapshot tester supports custom configs (@dsinghvi) " + type: chore + createdAt: "2023-10-01" + irVersion: 26 + version: 0.15.0-rc30 +- changelogEntry: + - summary: "- `--local` mode of the Fern CLI now correctly copies over generated + typescript code (@dsinghvi) " + type: chore + createdAt: "2023-09-30" + irVersion: 26 + version: 0.15.0-rc29 +- changelogEntry: + - summary: "- Bump generator versions to the latest (@amckinney) \r\n- Send undiscriminated\ + \ union type names to docs generation (@dsinghvi) " + type: chore + createdAt: "2023-09-29" + irVersion: 26 + version: 0.15.0-rc28 +- changelogEntry: + - summary: "- Support `go-fiber` generator (@connormahon34) " + type: chore + createdAt: "2023-09-26" + irVersion: 26 + version: 0.15.0-rc27 +- changelogEntry: + - summary: "- `fern generate --docs` will no longer fail because of network timeout + issues (@dsinghvi)" + type: chore + createdAt: "2023-09-25" + irVersion: 26 + version: 0.15.0-rc26 +- changelogEntry: + - summary: "- Add test fern definitions with endpoint examples(@amckinney) " + type: chore + createdAt: "2023-09-20" + irVersion: 26 + version: 0.15.0-rc25 +- changelogEntry: + - summary: "- `fern generate --docs` runs validation on the the docs configuration + (@dsinghvi) " + type: chore + createdAt: "2023-09-20" + irVersion: 26 + version: 0.15.0-rc24 +- changelogEntry: + - summary: "- Support reading AsyncAPI Schemas (@dsinghvi) " + type: chore + createdAt: "2023-09-19" + irVersion: 26 + version: 0.15.0-rc23 +- changelogEntry: + - summary: "- Add test definitions that contain examples(@amckinney) " + type: chore + createdAt: "2023-09-18" + irVersion: 26 + version: 0.15.0-rc22 +- changelogEntry: + - summary: "- Only set GA availablity if explicitly defined in the API Definition + (@dsinghvi) " + type: chore + createdAt: "2023-09-17" + irVersion: 26 + version: 0.15.0-rc21 +- changelogEntry: + - summary: "- Set version slug override (@dsinghvi) " + type: chore + createdAt: "2023-09-16" + irVersion: 26 + version: 0.15.0-rc20 +- changelogEntry: + - summary: "- docs.yml now supports showing API errors opt-in (@dsinghvi) " + type: chore + createdAt: "2023-09-13" + irVersion: 26 + version: 0.15.0-rc19 +- changelogEntry: + - summary: "- CLI now requires that versioned navbars live in new files (@dsinghvi)\ + \ \r\n- CLI supports sending availability (@dsinghvi) \r\n- CLI has new validation\ + \ rules for mdx + filepaths (@dsinghvi) " + type: chore + createdAt: "2023-09-13" + irVersion: 26 + version: 0.15.0-rc18 +- changelogEntry: + - summary: "- Docs support tabs (@dsinghvi) " + type: chore + createdAt: "2023-09-10" + irVersion: 25 + version: 0.15.0-rc17 +- changelogEntry: + - summary: "- Fix and make sure CLI adheres to `--api` flag when filtering API workspaces + (@dsinghvi) " + type: chore + createdAt: "2023-09-09" + irVersion: 25 + version: 0.15.0-rc16 +- changelogEntry: + - summary: "- Validate markdown for documentation (@dsinghvi) " + type: chore + createdAt: "2023-09-06" + irVersion: 25 + version: 0.15.0-rc15 +- changelogEntry: + - summary: "- Support specifying instance when running docs generation `fern generate + --docs --instance `" + type: chore + createdAt: "2023-09-06" + irVersion: 25 + version: 0.15.0-rc14 +- changelogEntry: + - summary: "- Support reading `description` on `$ref` fields in OpenAPI (@dsinghvi) " + type: chore + createdAt: "2023-09-05" + irVersion: 25 + version: 0.15.0-rc13 +- changelogEntry: + - summary: Release 0.15.0-rc12 + type: chore + createdAt: "2023-09-05" + irVersion: 25 + version: 0.15.0-rc12 +- changelogEntry: + - summary: "- Latest java generators depend on IR v25 to support text/plain responses + (@dsinghvi) " + type: chore + createdAt: "2023-09-05" + irVersion: 25 + version: 0.15.0-rc11 +- changelogEntry: + - summary: "- Add test definitions for `response: text` " + type: chore + createdAt: "2023-09-04" + irVersion: 25 + version: 0.15.0-rc9 +- changelogEntry: + - summary: "- Support text responses (@dsinghvi) " + type: chore + createdAt: "2023-09-04" + irVersion: 25 + version: 0.15.0-rc8 +- changelogEntry: + - summary: "- OpenAPI importer supports reading `application/octet-stream` requests + (@dsinghvi) " + type: chore + createdAt: "2023-09-04" + irVersion: 25 + version: 0.15.0-rc10 +- changelogEntry: + - summary: "- OpenAPI Importer handles deduping undiscriminated union types (@dsinghvi) " + type: chore + createdAt: "2023-08-31" + irVersion: 24 + version: 0.15.0-rc7 +- changelogEntry: + - summary: "- Respect audiences for service type graph (@amckinney) " + type: chore + createdAt: "2023-08-31" + irVersion: 24 + version: 0.15.0-rc6 +- changelogEntry: + - summary: "- Support reading `default` key in OpenAPI to account for headers with + literal value (@dsinghvi) " + type: chore + createdAt: "2023-08-30" + irVersion: 24 + version: 0.15.0-rc5 +- changelogEntry: + - summary: "- fern.config.json version is set to `*` which allows easier integration\ + \ with pnpm (@zachkirsch) \r\n- OpenAPI importer properly reads discriminated\ + \ unions so that discriminants are stripped from subtypes (@dsinghvi) " + type: chore + createdAt: "2023-08-30" + irVersion: 24 + version: 0.15.0-rc4 +- changelogEntry: + - summary: "- Support reading webhooks from OpenAPI specs (@dsinghvi) " + type: chore + createdAt: "2023-08-25" + irVersion: 24 + version: 0.15.0-rc3 +- changelogEntry: + - summary: "- Support uploading images with custom content types such as SVGs (@dsinghvi) " + type: chore + createdAt: "2023-08-23" + irVersion: 24 + version: 0.15.0-rc2 +- changelogEntry: + - summary: "- Update discriminated union detection to handle referenced schemas + (@dsinghvi) " + type: chore + createdAt: "2023-08-18" + irVersion: 23 + version: 0.15.0-rc1 +- changelogEntry: + - summary: "- **Break**: The fern directory now has a top-level `apis` directory + to handle apis and docs no longer live within an api definition" + type: chore + createdAt: "2023-08-16" + irVersion: 23 + version: 0.15.0-rc0 +- changelogEntry: + - summary: Release 0.14.4-rc2 + type: chore + createdAt: "2023-08-14" + irVersion: 23 + version: 0.14.4-rc2 +- changelogEntry: + - summary: Release 0.14.4-rc1 + type: chore + createdAt: "2023-08-14" + irVersion: 23 + version: 0.14.4-rc1 +- changelogEntry: + - summary: CLI handles property names that start with numbers for code generation + (@dsinghvi) + type: chore + createdAt: "2023-08-11" + irVersion: 23 + version: 0.14.4-rc0 +- changelogEntry: + - summary: "- When `docs` is missing, the CLI should nudge the user to run `fern + add docs` (@dannysheridan) " + type: chore + createdAt: "2023-08-08" + irVersion: 23 + version: 0.14.3 +- changelogEntry: + - summary: "- When running `fern init --openapi ` the OpenAPI generator + wont be included (@dannysheridan) " + type: chore + createdAt: "2023-08-08" + irVersion: 23 + version: 0.14.2 +- changelogEntry: + - summary: "- Rerelease `0.14.0`" + type: chore + createdAt: "2023-08-07" + irVersion: 22 + version: 0.14.1 +- changelogEntry: + - summary: "- The latest Go SDK Generator depends on IR V22 (@amckinney) " + type: chore + createdAt: "2023-08-07" + irVersion: 22 + version: 0.14.0 +- changelogEntry: + - summary: '- Handle `type: "null"` when importing OpenAPI oneOf (@dsinghvi) ' + type: chore + createdAt: "2023-08-05" + irVersion: 22 + version: 0.13.0 +- changelogEntry: + - summary: "- No changes" + type: chore + createdAt: "2023-08-05" + irVersion: 22 + version: 0.13.0-rc3 +- changelogEntry: + - summary: "- Java generators now require IR V20 (@dsinghvi) " + type: chore + createdAt: "2023-08-03" + irVersion: 22 + version: 0.13.0-rc2 +- changelogEntry: + - summary: "- OpenAPI generator only includes current package as part of generated + name (@dsinghvi) " + type: chore + createdAt: "2023-08-02" + irVersion: 22 + version: 0.13.0-rc1 +- changelogEntry: + - summary: "- OpenAPI oneOf subtypes have generated names based on unique properties + (@dsinghvi) " + type: chore + createdAt: "2023-08-02" + irVersion: 22 + version: 0.13.0-rc0 +- changelogEntry: + - summary: "- OpenAPI importer converts `date-times` appropriately. Before this + release, datetimes would be converted as strings. (@dsinghvi)" + type: chore + createdAt: "2023-08-02" + irVersion: 22 + version: 0.12.0 +- changelogEntry: + - summary: "- Special case importing oneOf types that are all enums (@dsinghvi) " + type: chore + createdAt: "2023-08-02" + irVersion: 22 + version: 0.11.12 +- changelogEntry: + - summary: "* Add `ServiceTypeReferenceInfo` to IR so that generators can recognize\ + \ what types are referenced from exactly one service (@amckinney).\r\n```yaml\r\ + \n ServiceTypeReferenceInfo:\r\n properties:\r\n typesReferencedOnlyByService:\r\ + \n docs: \"Types referenced by exactly one service.\"\r\n type:\ + \ map>\r\n sharedTypes:\r\n \ + \ docs: \"Types referenced by either zero or multiple services.\"\r\n \ + \ type: list\r\n```" + type: chore + createdAt: "2023-08-01" + irVersion: 22 + version: 0.11.12-rc2 +- changelogEntry: + - summary: "- Specify license in generators.yml (@amckinney) \r\n```yaml\r\ngroups:\ + \ \r\n publish: \r\n - name: fernapi/fern-go-sdk\r\n version: 0.0.1\r\ + \n github: \r\n repository: my-org/my-repo\r\n license: MIT\ + \ # <------- or Apache-2.0\r\n```" + type: chore + createdAt: "2023-07-29" + irVersion: 22 + version: 0.11.12-rc0 +- changelogEntry: + - summary: "- Support `x-fern-ignore` OpenAPI extension. This extensions configures\ + \ fern to ignore certain endpoints when generating SDKs. (@dsinghvi) \r\n ```yaml\r\ + \n paths: \r\n my/endpoint/path: \r\n get: \r\n x-fern-ignore:\ + \ true # <------- fern will skip this endpoint\r\n ```" + type: chore + createdAt: "2023-07-29" + irVersion: 22 + version: 0.11.12-rc1 +- changelogEntry: + - summary: "- OpenAPI importer handles converting numbers formatted as time-delta + (@dsinghvi)" + type: chore + createdAt: "2023-07-28" + irVersion: 22 + version: 0.11.11 +- changelogEntry: + - summary: "- OpenAPI importer handles converting servers with `staging` and `production`\ + \ descriptions (@dsinghvi) \r\n- Generators are upgraded in fern init (@dannysheridan)\ + \ \r\n- Documentation markdown paths are validated (@zachkirsch)" + type: chore + createdAt: "2023-07-26" + irVersion: 22 + version: 0.11.10 +- changelogEntry: + - summary: "- handles `x-ndjson` content-type in OpenAPI responses" + type: chore + createdAt: "2023-07-24" + irVersion: 22 + version: 0.11.9 +- changelogEntry: + - summary: Release 0.11.9-rc0 + type: chore + createdAt: "2023-07-23" + irVersion: 22 + version: 0.11.9-rc0 +- changelogEntry: + - summary: "- Register custom content types when reading from OpenAPI spec" + type: chore + createdAt: "2023-07-23" + irVersion: 22 + version: 0.11.8 +- changelogEntry: + - summary: "- Register content-types when registering docs (i.e. such as `application/x-ndjson`)" + type: chore + createdAt: "2023-07-23" + irVersion: 22 + version: 0.11.8-rc0 +- changelogEntry: + - summary: Release 0.11.7 + type: chore + createdAt: "2023-07-23" + irVersion: 22 + version: 0.11.7 +- changelogEntry: + - summary: Release 0.11.7-rc9 + type: chore + createdAt: "2023-07-23" + irVersion: 22 + version: 0.11.7-rc9 +- changelogEntry: + - summary: Release 0.11.7-rc8 + type: chore + createdAt: "2023-07-23" + irVersion: 22 + version: 0.11.7-rc8 +- changelogEntry: + - summary: Release 0.11.7-rc7 + type: chore + createdAt: "2023-07-22" + irVersion: 22 + version: 0.11.7-rc7 +- changelogEntry: + - summary: Release 0.11.7-rc6 + type: chore + createdAt: "2023-07-22" + irVersion: 22 + version: 0.11.7-rc6 +- changelogEntry: + - summary: Release 0.11.7-rc5 + type: chore + createdAt: "2023-07-22" + irVersion: 22 + version: 0.11.7-rc5 +- changelogEntry: + - summary: "- Hacky release with sleep 5s before running docker" + type: chore + createdAt: "2023-07-21" + irVersion: 22 + version: 0.11.7-rc4 +- changelogEntry: + - summary: Release 0.11.7-rc3 + type: chore + createdAt: "2023-07-20" + irVersion: 22 + version: 0.11.7-rc3 +- changelogEntry: + - summary: "- Pypi token is correctly read in for publishing" + type: chore + createdAt: "2023-07-18" + irVersion: 22 + version: 0.11.7-rc2 +- changelogEntry: + - summary: Release 0.11.7-rc1 + type: chore + createdAt: "2023-07-14" + irVersion: 22 + version: 0.11.7-rc1 +- changelogEntry: + - summary: Release 0.11.7-rc0 + type: chore + createdAt: "2023-07-13" + irVersion: 22 + version: 0.11.7-rc0 +- changelogEntry: + - summary: Release 0.11.6 + type: chore + createdAt: "2023-07-11" + irVersion: 22 + version: 0.11.6 +- changelogEntry: + - summary: Release 0.11.6-rc1 + type: chore + createdAt: "2023-07-11" + irVersion: 22 + version: 0.11.6-rc1 +- changelogEntry: + - summary: Release 0.11.6-rc0 + type: chore + createdAt: "2023-07-11" + irVersion: 22 + version: 0.11.6-rc0 +- changelogEntry: + - summary: "- Fixes https://github.com/fern-api/fern/issues/1880 (no longer forced + to define auth if endpoints don't require auth)" + type: chore + createdAt: "2023-07-10" + irVersion: 22 + version: 0.11.5 +- changelogEntry: + - summary: Release 0.11.4 + type: chore + createdAt: "2023-07-06" + irVersion: 22 + version: 0.11.4 +- changelogEntry: + - summary: Release 0.11.4-rc0 + type: chore + createdAt: "2023-07-06" + irVersion: 22 + version: 0.11.4-rc0 +- changelogEntry: + - summary: Release 0.11.3 + type: chore + createdAt: "2023-07-06" + irVersion: 22 + version: 0.11.3 +- changelogEntry: + - summary: Release 0.11.3-rc9 + type: chore + createdAt: "2023-07-06" + irVersion: 22 + version: 0.11.3-rc9 +- changelogEntry: + - summary: Release 0.11.3-rc8 + type: chore + createdAt: "2023-07-06" + irVersion: 22 + version: 0.11.3-rc8 +- changelogEntry: + - summary: Release 0.11.3-rc7 + type: chore + createdAt: "2023-07-06" + irVersion: 22 + version: 0.11.3-rc7 +- changelogEntry: + - summary: Release 0.11.3-rc6 + type: chore + createdAt: "2023-07-06" + irVersion: 22 + version: 0.11.3-rc6 +- changelogEntry: + - summary: Release 0.11.3-rc5 + type: chore + createdAt: "2023-07-06" + irVersion: 22 + version: 0.11.3-rc5 +- changelogEntry: + - summary: Release 0.11.3-rc10 + type: chore + createdAt: "2023-07-06" + irVersion: 22 + version: 0.11.3-rc10 +- changelogEntry: + - summary: Release 0.11.3-rc4 + type: chore + createdAt: "2023-07-05" + irVersion: 20 + version: 0.11.3-rc4 +- changelogEntry: + - summary: Release 0.11.3-rc3 + type: chore + createdAt: "2023-06-28" + irVersion: 20 + version: 0.11.3-rc3 +- changelogEntry: + - summary: Release 0.11.3-rc2 + type: chore + createdAt: "2023-06-28" + irVersion: 20 + version: 0.11.3-rc2 +- changelogEntry: + - summary: "- Support reading `x-fern-audiences` extension so that OpenAPI spec + users can leverage fern audiences" + type: chore + createdAt: "2023-06-28" + irVersion: 20 + version: 0.11.3-rc1 +- changelogEntry: + - summary: Release 0.11.3-rc0 + type: chore + createdAt: "2023-06-24" + irVersion: 20 + version: 0.11.3-rc0 +- changelogEntry: + - summary: Release 0.11.2 + type: chore + createdAt: "2023-06-23" + irVersion: 20 + version: 0.11.2 +- changelogEntry: + - summary: Release 0.11.1-rc0 + type: chore + createdAt: "2023-06-22" + irVersion: 20 + version: 0.11.1-rc0 +- changelogEntry: + - summary: "- Update OpenAPI Importer logic to handle FastAPI operation ids" + type: chore + createdAt: "2023-06-22" + irVersion: 20 + version: 0.11.0 +- changelogEntry: + - summary: Release 0.10.28 + type: chore + createdAt: "2023-06-20" + irVersion: 20 + version: 0.10.28 +- changelogEntry: + - summary: Release 0.10.27 + type: chore + createdAt: "2023-06-20" + irVersion: 20 + version: 0.10.27 +- changelogEntry: + - summary: Release 0.10.27-rc0 + type: chore + createdAt: "2023-06-15" + irVersion: 20 + version: 0.10.27-rc0 +- changelogEntry: + - summary: Release 0.10.26 + type: chore + createdAt: "2023-06-15" + irVersion: 20 + version: 0.10.26 +- changelogEntry: + - summary: Release 0.10.25 + type: chore + createdAt: "2023-06-15" + irVersion: 20 + version: 0.10.25 +- changelogEntry: + - summary: Release 0.10.25-rc1 + type: chore + createdAt: "2023-06-14" + irVersion: 20 + version: 0.10.25-rc1 +- changelogEntry: + - summary: Release 0.10.25-rc0 + type: chore + createdAt: "2023-06-13" + irVersion: 20 + version: 0.10.25-rc0 +- changelogEntry: + - summary: "- Fixes https://github.com/fern-api/fern/issues/1765 so OpenAPI specs + are not required to have `operationId` or `x-fern-sdk-method-name` " + type: chore + createdAt: "2023-06-13" + irVersion: 20 + version: 0.10.24 +- changelogEntry: + - summary: Release 0.10.23 + type: chore + createdAt: "2023-06-13" + irVersion: 20 + version: 0.10.23 +- changelogEntry: + - summary: Release 0.10.23-rc0 + type: chore + createdAt: "2023-06-12" + irVersion: 20 + version: 0.10.23-rc0 +- changelogEntry: + - summary: Release 0.10.22 + type: chore + createdAt: "2023-06-12" + irVersion: 20 + version: 0.10.22 +- changelogEntry: + - summary: Release 0.10.21 + type: chore + createdAt: "2023-06-12" + irVersion: 20 + version: 0.10.21 +- changelogEntry: + - summary: Release 0.10.20 + type: chore + createdAt: "2023-06-12" + irVersion: 20 + version: 0.10.20 +- changelogEntry: + - summary: Release 0.10.20-rc0 + type: chore + createdAt: "2023-06-12" + irVersion: 20 + version: 0.10.20-rc0 +- changelogEntry: + - summary: Release 0.10.19 + type: chore + createdAt: "2023-06-12" + irVersion: 20 + version: 0.10.19 +- changelogEntry: + - summary: Release 0.10.18 + type: chore + createdAt: "2023-06-11" + irVersion: 20 + version: 0.10.18 +- changelogEntry: + - summary: Release 0.10.17 + type: chore + createdAt: "2023-06-11" + irVersion: 20 + version: 0.10.17 +- changelogEntry: + - summary: Release 0.10.16 + type: chore + createdAt: "2023-06-11" + irVersion: 20 + version: 0.10.16 +- changelogEntry: + - summary: Release 0.10.15 + type: chore + createdAt: "2023-06-10" + irVersion: 20 + version: 0.10.15 +- changelogEntry: + - summary: Release 0.10.14 + type: chore + createdAt: "2023-06-10" + irVersion: 20 + version: 0.10.14 +- changelogEntry: + - summary: Release 0.10.14-rc0 + type: chore + createdAt: "2023-06-10" + irVersion: 20 + version: 0.10.14-rc0 +- changelogEntry: + - summary: Release 0.10.13 + type: chore + createdAt: "2023-06-09" + irVersion: 20 + version: 0.10.13 +- changelogEntry: + - summary: Release 0.10.13-rc2 + type: chore + createdAt: "2023-06-09" + irVersion: 20 + version: 0.10.13-rc2 +- changelogEntry: + - summary: Release 0.10.13-rc1 + type: chore + createdAt: "2023-06-09" + irVersion: 20 + version: 0.10.13-rc1 +- changelogEntry: + - summary: Release 0.10.13-rc0 + type: chore + createdAt: "2023-06-09" + irVersion: 20 + version: 0.10.13-rc0 +- changelogEntry: + - summary: Release 0.10.12 + type: chore + createdAt: "2023-06-09" + irVersion: 20 + version: 0.10.12 +- changelogEntry: + - summary: Release 0.10.11 + type: chore + createdAt: "2023-06-09" + irVersion: 20 + version: 0.10.11 +- changelogEntry: + - summary: Release 0.10.11-rc0 + type: chore + createdAt: "2023-06-08" + irVersion: 20 + version: 0.10.11-rc0 +- changelogEntry: + - summary: Release 0.10.10 + type: chore + createdAt: "2023-06-08" + irVersion: 20 + version: 0.10.10 +- changelogEntry: + - summary: Release 0.10.10-rc2 + type: chore + createdAt: "2023-06-08" + irVersion: 20 + version: 0.10.10-rc2 +- changelogEntry: + - summary: Release 0.10.10-rc1 + type: chore + createdAt: "2023-06-08" + irVersion: 20 + version: 0.10.10-rc1 +- changelogEntry: + - summary: Release 0.10.10-rc0 + type: chore + createdAt: "2023-06-08" + irVersion: 20 + version: 0.10.10-rc0 +- changelogEntry: + - summary: Release 0.10.9 + type: chore + createdAt: "2023-06-07" + irVersion: 20 + version: 0.10.9 +- changelogEntry: + - summary: Release 0.10.8 + type: chore + createdAt: "2023-06-07" + irVersion: 20 + version: 0.10.8 +- changelogEntry: + - summary: Release 0.10.8-rc0 + type: chore + createdAt: "2023-06-07" + irVersion: 20 + version: 0.10.8-rc0 +- changelogEntry: + - summary: Release 0.10.7 + type: chore + createdAt: "2023-06-06" + irVersion: 20 + version: 0.10.7 +- changelogEntry: + - summary: Release 0.10.6 + type: chore + createdAt: "2023-06-06" + irVersion: 20 + version: 0.10.6 +- changelogEntry: + - summary: Release 0.10.5 + type: chore + createdAt: "2023-06-06" + irVersion: 20 + version: 0.10.5 +- changelogEntry: + - summary: Release 0.10.4 + type: chore + createdAt: "2023-06-06" + irVersion: 20 + version: 0.10.4 +- changelogEntry: + - summary: Release 0.10.3 + type: chore + createdAt: "2023-06-06" + irVersion: 20 + version: 0.10.3 +- changelogEntry: + - summary: Release 0.10.2 + type: chore + createdAt: "2023-06-05" + irVersion: 20 + version: 0.10.2 +- changelogEntry: + - summary: Release 0.10.1 + type: chore + createdAt: "2023-06-05" + irVersion: 20 + version: 0.10.1 +- changelogEntry: + - summary: "- The docs `domain` must be a full domain ending in `docs.buildwithfern.com`\r\ + \n- `docs.yml` now supports custom-domains so that docs can redirect from a\ + \ custom url" + type: chore + createdAt: "2023-06-05" + irVersion: 20 + version: 0.10.0 +- changelogEntry: + - summary: Release 0.9.10 + type: chore + createdAt: "2023-06-02" + irVersion: 20 + version: 0.9.10 +- changelogEntry: + - summary: Release 0.9.10-rc0 + type: chore + createdAt: "2023-05-31" + irVersion: 20 + version: 0.9.10-rc0 +- changelogEntry: + - summary: Release 0.9.9 + type: chore + createdAt: "2023-05-31" + irVersion: 20 + version: 0.9.9 +- changelogEntry: + - summary: Release 0.9.9-rc4 + type: chore + createdAt: "2023-05-31" + irVersion: 20 + version: 0.9.9-rc4 +- changelogEntry: + - summary: Release 0.9.9-rc3 + type: chore + createdAt: "2023-05-31" + irVersion: 20 + version: 0.9.9-rc3 +- changelogEntry: + - summary: Release 0.9.9-rc2 + type: chore + createdAt: "2023-05-31" + irVersion: 20 + version: 0.9.9-rc2 +- changelogEntry: + - summary: Release 0.9.9-rc1 + type: chore + createdAt: "2023-05-31" + irVersion: 20 + version: 0.9.9-rc1 +- changelogEntry: + - summary: Release 0.9.9-rc0 + type: chore + createdAt: "2023-05-31" + irVersion: 20 + version: 0.9.9-rc0 +- changelogEntry: + - summary: Release 0.9.8 + type: chore + createdAt: "2023-05-30" + irVersion: 20 + version: 0.9.8 +- changelogEntry: + - summary: Release 0.9.8-rc0 + type: chore + createdAt: "2023-05-30" + irVersion: 20 + version: 0.9.8-rc0 +- changelogEntry: + - summary: Release 0.9.7 + type: chore + createdAt: "2023-05-30" + irVersion: 20 + version: 0.9.7 +- changelogEntry: + - summary: Release 0.9.7-rc2 + type: chore + createdAt: "2023-05-30" + irVersion: 20 + version: 0.9.7-rc2 +- changelogEntry: + - summary: Release 0.9.7-rc1 + type: chore + createdAt: "2023-05-29" + irVersion: 20 + version: 0.9.7-rc1 +- changelogEntry: + - summary: Release 0.9.7-rc0 + type: chore + createdAt: "2023-05-29" + irVersion: 20 + version: 0.9.7-rc0 +- changelogEntry: + - summary: Release 0.9.6 + type: chore + createdAt: "2023-05-29" + irVersion: 20 + version: 0.9.6 +- changelogEntry: + - summary: Release 0.9.6-rc1 + type: chore + createdAt: "2023-05-28" + irVersion: 20 + version: 0.9.6-rc1 +- changelogEntry: + - summary: Release 0.9.6-rc0 + type: chore + createdAt: "2023-05-28" + irVersion: 20 + version: 0.9.6-rc0 +- changelogEntry: + - summary: Release 0.9.5 + type: chore + createdAt: "2023-05-27" + irVersion: 20 + version: 0.9.5 +- changelogEntry: + - summary: "- `fern init` reads `FERN_TOKEN` if the user token is not available" + type: chore + createdAt: "2023-05-27" + irVersion: 20 + version: 0.9.4 +- changelogEntry: + - summary: Release 0.9.4-rc3 + type: chore + createdAt: "2023-05-25" + irVersion: 20 + version: 0.9.4-rc3 +- changelogEntry: + - summary: Release 0.9.4-rc2 + type: chore + createdAt: "2023-05-25" + irVersion: 20 + version: 0.9.4-rc2 +- changelogEntry: + - summary: Release 0.9.4-rc1 + type: chore + createdAt: "2023-05-25" + irVersion: 20 + version: 0.9.4-rc1 +- changelogEntry: + - summary: Release 0.9.4-rc0 + type: chore + createdAt: "2023-05-25" + irVersion: 20 + version: 0.9.4-rc0 +- changelogEntry: + - summary: Release 0.9.3 + type: chore + createdAt: "2023-05-24" + irVersion: 20 + version: 0.9.3 +- changelogEntry: + - summary: Release 0.9.2 + type: chore + createdAt: "2023-05-24" + irVersion: 20 + version: 0.9.2 +- changelogEntry: + - summary: Release 0.9.2-rc5 + type: chore + createdAt: "2023-05-24" + irVersion: 20 + version: 0.9.2-rc5 +- changelogEntry: + - summary: Release 0.9.2-rc4 + type: chore + createdAt: "2023-05-24" + irVersion: 20 + version: 0.9.2-rc4 +- changelogEntry: + - summary: Release 0.9.2-rc3 + type: chore + createdAt: "2023-05-24" + irVersion: 20 + version: 0.9.2-rc3 +- changelogEntry: + - summary: Release 0.9.2-rc2 + type: chore + createdAt: "2023-05-23" + irVersion: 20 + version: 0.9.2-rc2 +- changelogEntry: + - summary: Release 0.9.2-rc1 + type: chore + createdAt: "2023-05-23" + irVersion: 20 + version: 0.9.2-rc1 +- changelogEntry: + - summary: Release 0.9.2-rc0 + type: chore + createdAt: "2023-05-21" + irVersion: 20 + version: 0.9.2-rc0 +- changelogEntry: + - summary: Release 0.9.1 + type: chore + createdAt: "2023-05-20" + irVersion: 20 + version: 0.9.1 +- changelogEntry: + - summary: Release 0.9.1-rc3 + type: chore + createdAt: "2023-05-20" + irVersion: 20 + version: 0.9.1-rc3 +- changelogEntry: + - summary: Release 0.9.1-rc2 + type: chore + createdAt: "2023-05-19" + irVersion: 20 + version: 0.9.1-rc2 +- changelogEntry: + - summary: Release 0.9.1-rc1 + type: chore + createdAt: "2023-05-18" + irVersion: 20 + version: 0.9.1-rc1 +- changelogEntry: + - summary: Release 0.9.1-rc0 + type: chore + createdAt: "2023-05-18" + irVersion: 20 + version: 0.9.1-rc0 +- changelogEntry: + - summary: Running `fern init --openapi ` creates an OpenAPI workspace + type: chore + createdAt: "2023-05-17" + irVersion: 20 + version: 0.9.0 +- changelogEntry: + - summary: Release 0.9.0-rc0 + type: chore + createdAt: "2023-05-17" + irVersion: 20 + version: 0.9.0-rc0 +- changelogEntry: + - summary: Add `fern-go-model` generator identifier. + type: chore + createdAt: "2023-05-16" + irVersion: 20 + version: 0.8.25-rc0 +- changelogEntry: + - summary: Release 0.8.24 + type: chore + createdAt: "2023-05-16" + irVersion: 20 + version: 0.8.24 +- changelogEntry: + - summary: Release 0.8.23 + type: chore + createdAt: "2023-05-13" + irVersion: 20 + version: 0.8.23 +- changelogEntry: + - summary: Release 0.8.22 + type: chore + createdAt: "2023-05-13" + irVersion: 20 + version: 0.8.22 +- changelogEntry: + - summary: Release 0.8.21 + type: chore + createdAt: "2023-05-13" + irVersion: 20 + version: 0.8.21 +- changelogEntry: + - summary: Release 0.8.20 + type: chore + createdAt: "2023-05-12" + irVersion: 20 + version: 0.8.20 +- changelogEntry: + - summary: Release 0.8.20-rc4 + type: chore + createdAt: "2023-05-12" + irVersion: 20 + version: 0.8.20-rc4 +- changelogEntry: + - summary: Release 0.8.20-rc3 + type: chore + createdAt: "2023-05-12" + irVersion: 20 + version: 0.8.20-rc3 +- changelogEntry: + - summary: Release 0.8.20-rc2 + type: chore + createdAt: "2023-05-11" + irVersion: 20 + version: 0.8.20-rc2 +- changelogEntry: + - summary: Release 0.8.20-rc1 + type: chore + createdAt: "2023-05-11" + irVersion: 20 + version: 0.8.20-rc1 +- changelogEntry: + - summary: Release 0.8.20-rc0 + type: chore + createdAt: "2023-05-11" + irVersion: 20 + version: 0.8.20-rc0 +- changelogEntry: + - summary: Release 0.8.19 + type: chore + createdAt: "2023-05-11" + irVersion: 20 + version: 0.8.19 +- changelogEntry: + - summary: Release 0.8.19-rc9 + type: chore + createdAt: "2023-05-11" + irVersion: 20 + version: 0.8.19-rc9 +- changelogEntry: + - summary: Release 0.8.19-rc8 + type: chore + createdAt: "2023-05-11" + irVersion: 20 + version: 0.8.19-rc8 +- changelogEntry: + - summary: Release 0.8.19-rc7 + type: chore + createdAt: "2023-05-10" + irVersion: 20 + version: 0.8.19-rc7 +- changelogEntry: + - summary: Release 0.8.19-rc6 + type: chore + createdAt: "2023-05-10" + irVersion: 20 + version: 0.8.19-rc6 +- changelogEntry: + - summary: Release 0.8.19-rc5 + type: chore + createdAt: "2023-05-10" + irVersion: 20 + version: 0.8.19-rc5 +- changelogEntry: + - summary: Release 0.8.19-rc4 + type: chore + createdAt: "2023-05-10" + irVersion: 20 + version: 0.8.19-rc4 +- changelogEntry: + - summary: Release 0.8.19-rc3 + type: chore + createdAt: "2023-05-10" + irVersion: 20 + version: 0.8.19-rc3 +- changelogEntry: + - summary: Release 0.8.19-rc2 + type: chore + createdAt: "2023-05-10" + irVersion: 20 + version: 0.8.19-rc2 +- changelogEntry: + - summary: Release 0.8.19-rc1 + type: chore + createdAt: "2023-05-10" + irVersion: 20 + version: 0.8.19-rc1 +- changelogEntry: + - summary: Release 0.8.19-rc0 + type: chore + createdAt: "2023-05-10" + irVersion: 20 + version: 0.8.19-rc0 +- changelogEntry: + - summary: Release 0.8.18 + type: chore + createdAt: "2023-05-08" + irVersion: 20 + version: 0.8.18 +- changelogEntry: + - summary: Release 0.8.17 + type: chore + createdAt: "2023-05-08" + irVersion: 20 + version: 0.8.17 +- changelogEntry: + - summary: Release 0.8.17-rc3 + type: chore + createdAt: "2023-05-08" + irVersion: 20 + version: 0.8.17-rc3 +- changelogEntry: + - summary: Release 0.8.17-rc2 + type: chore + createdAt: "2023-05-08" + irVersion: 20 + version: 0.8.17-rc2 +- changelogEntry: + - summary: Release 0.8.17-rc1 + type: chore + createdAt: "2023-05-08" + irVersion: 20 + version: 0.8.17-rc1 +- changelogEntry: + - summary: Release 0.8.17-rc0 + type: chore + createdAt: "2023-05-08" + irVersion: 20 + version: 0.8.17-rc0 +- changelogEntry: + - summary: Release 0.8.16-rc9 + type: chore + createdAt: "2023-05-08" + irVersion: 20 + version: 0.8.16-rc9 +- changelogEntry: + - summary: Release 0.8.16-rc8 + type: chore + createdAt: "2023-05-08" + irVersion: 19 + version: 0.8.16-rc8 +- changelogEntry: + - summary: Release 0.8.16-rc7 + type: chore + createdAt: "2023-05-08" + irVersion: 19 + version: 0.8.16-rc7 +- changelogEntry: + - summary: Release 0.8.16-rc6 + type: chore + createdAt: "2023-05-08" + irVersion: 19 + version: 0.8.16-rc6 +- changelogEntry: + - summary: Release 0.8.16-rc5 + type: chore + createdAt: "2023-05-08" + irVersion: 19 + version: 0.8.16-rc5 +- changelogEntry: + - summary: Release 0.8.16-rc11 + type: chore + createdAt: "2023-05-08" + irVersion: 20 + version: 0.8.16-rc11 +- changelogEntry: + - summary: Release 0.8.16-rc10 + type: chore + createdAt: "2023-05-08" + irVersion: 20 + version: 0.8.16-rc10 +- changelogEntry: + - summary: Release 0.8.16-rc4 + type: chore + createdAt: "2023-05-07" + irVersion: 19 + version: 0.8.16-rc4 +- changelogEntry: + - summary: Release 0.8.16-rc3 + type: chore + createdAt: "2023-05-07" + irVersion: 19 + version: 0.8.16-rc3 +- changelogEntry: + - summary: Release 0.8.16-rc2 + type: chore + createdAt: "2023-05-07" + irVersion: 19 + version: 0.8.16-rc2 +- changelogEntry: + - summary: Release 0.8.16-rc1 + type: chore + createdAt: "2023-05-07" + irVersion: 19 + version: 0.8.16-rc1 +- changelogEntry: + - summary: Release 0.8.16-rc0 + type: chore + createdAt: "2023-05-07" + irVersion: 19 + version: 0.8.16-rc0 +- changelogEntry: + - summary: Release 0.8.15 + type: chore + createdAt: "2023-05-07" + irVersion: 19 + version: 0.8.15 +- changelogEntry: + - summary: Release 0.8.14 + type: chore + createdAt: "2023-05-07" + irVersion: 19 + version: 0.8.14 +- changelogEntry: + - summary: Release 0.8.13 + type: chore + createdAt: "2023-05-07" + irVersion: 19 + version: 0.8.13 +- changelogEntry: + - summary: Release 0.8.13-rc2 + type: chore + createdAt: "2023-05-07" + irVersion: 19 + version: 0.8.13-rc2 +- changelogEntry: + - summary: Release 0.8.13-rc1 + type: chore + createdAt: "2023-05-07" + irVersion: 19 + version: 0.8.13-rc1 +- changelogEntry: + - summary: Release 0.8.13-rc0 + type: chore + createdAt: "2023-05-06" + irVersion: 19 + version: 0.8.13-rc0 +- changelogEntry: + - summary: Release 0.8.12 + type: chore + createdAt: "2023-05-05" + irVersion: 19 + version: 0.8.12 +- changelogEntry: + - summary: Release 0.8.11 + type: chore + createdAt: "2023-05-05" + irVersion: 19 + version: 0.8.11 +- changelogEntry: + - summary: Release 0.8.10 + type: chore + createdAt: "2023-05-05" + irVersion: 19 + version: 0.8.10 +- changelogEntry: + - summary: Release 0.8.9 + type: chore + createdAt: "2023-05-04" + irVersion: 19 + version: 0.8.9 +- changelogEntry: + - summary: Release 0.8.8 + type: chore + createdAt: "2023-05-04" + irVersion: 19 + version: 0.8.8 +- changelogEntry: + - summary: Release 0.8.7 + type: chore + createdAt: "2023-05-04" + irVersion: 19 + version: 0.8.7 +- changelogEntry: + - summary: Release 0.8.6 + type: chore + createdAt: "2023-05-03" + irVersion: 19 + version: 0.8.6 +- changelogEntry: + - summary: Release 0.8.6-rc2 + type: chore + createdAt: "2023-05-03" + irVersion: 19 + version: 0.8.6-rc2 +- changelogEntry: + - summary: Release 0.8.6-rc1 + type: chore + createdAt: "2023-05-03" + irVersion: 19 + version: 0.8.6-rc1 +- changelogEntry: + - summary: Release 0.8.6-rc0 + type: chore + createdAt: "2023-05-03" + irVersion: 19 + version: 0.8.6-rc0 +- changelogEntry: + - summary: Release 0.8.5 + type: chore + createdAt: "2023-05-03" + irVersion: 19 + version: 0.8.5 +- changelogEntry: + - summary: Release 0.8.4 + type: chore + createdAt: "2023-05-03" + irVersion: 19 + version: 0.8.4 +- changelogEntry: + - summary: Release 0.8.3 + type: chore + createdAt: "2023-05-03" + irVersion: 19 + version: 0.8.3 +- changelogEntry: + - summary: Release 0.8.2 + type: chore + createdAt: "2023-05-03" + irVersion: 19 + version: 0.8.2 +- changelogEntry: + - summary: Release 0.8.1 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.1 +- changelogEntry: + - summary: Release 0.8.0 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.0 +- changelogEntry: + - summary: Release 0.8.0-rc9 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.0-rc9 +- changelogEntry: + - summary: Release 0.8.0-rc8 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.0-rc8 +- changelogEntry: + - summary: Release 0.8.0-rc7 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.0-rc7 +- changelogEntry: + - summary: Release 0.8.0-rc6 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.0-rc6 +- changelogEntry: + - summary: Release 0.8.0-rc5 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.0-rc5 +- changelogEntry: + - summary: Release 0.8.0-rc4 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.0-rc4 +- changelogEntry: + - summary: Release 0.8.0-rc3 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.0-rc3 +- changelogEntry: + - summary: Release 0.8.0-rc2 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.0-rc2 +- changelogEntry: + - summary: Release 0.8.0-rc1 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.0-rc1 +- changelogEntry: + - summary: Release 0.8.0-rc0 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.8.0-rc0 +- changelogEntry: + - summary: Release 0.7.5-rc17 + type: chore + createdAt: "2023-05-02" + irVersion: 19 + version: 0.7.5-rc17 +- changelogEntry: + - summary: Release 0.7.5-rc9 + type: chore + createdAt: "2023-05-01" + irVersion: 19 + version: 0.7.5-rc9 +- changelogEntry: + - summary: Release 0.7.5-rc8 + type: chore + createdAt: "2023-05-01" + irVersion: 19 + version: 0.7.5-rc8 +- changelogEntry: + - summary: Release 0.7.5-rc7 + type: chore + createdAt: "2023-05-01" + irVersion: 19 + version: 0.7.5-rc7 +- changelogEntry: + - summary: Release 0.7.5-rc16 + type: chore + createdAt: "2023-05-01" + irVersion: 19 + version: 0.7.5-rc16 +- changelogEntry: + - summary: Release 0.7.5-rc15 + type: chore + createdAt: "2023-05-01" + irVersion: 19 + version: 0.7.5-rc15 +- changelogEntry: + - summary: Release 0.7.5-rc14 + type: chore + createdAt: "2023-05-01" + irVersion: 19 + version: 0.7.5-rc14 +- changelogEntry: + - summary: Release 0.7.5-rc13 + type: chore + createdAt: "2023-05-01" + irVersion: 19 + version: 0.7.5-rc13 +- changelogEntry: + - summary: Release 0.7.5-rc12 + type: chore + createdAt: "2023-05-01" + irVersion: 19 + version: 0.7.5-rc12 +- changelogEntry: + - summary: Release 0.7.5-rc11 + type: chore + createdAt: "2023-05-01" + irVersion: 19 + version: 0.7.5-rc11 +- changelogEntry: + - summary: Release 0.7.5-rc10 + type: chore + createdAt: "2023-05-01" + irVersion: 19 + version: 0.7.5-rc10 +- changelogEntry: + - summary: Release 0.7.5-rc6 + type: chore + createdAt: "2023-04-30" + irVersion: 19 + version: 0.7.5-rc6 +- changelogEntry: + - summary: Release 0.7.5-rc5 + type: chore + createdAt: "2023-04-30" + irVersion: 19 + version: 0.7.5-rc5 +- changelogEntry: + - summary: Release 0.7.5-rc4 + type: chore + createdAt: "2023-04-30" + irVersion: 19 + version: 0.7.5-rc4 +- changelogEntry: + - summary: Release 0.7.5-rc3 + type: chore + createdAt: "2023-04-30" + irVersion: 19 + version: 0.7.5-rc3 +- changelogEntry: + - summary: Release 0.7.5-rc2 + type: chore + createdAt: "2023-04-30" + irVersion: 19 + version: 0.7.5-rc2 +- changelogEntry: + - summary: Release 0.7.5-rc1 + type: chore + createdAt: "2023-04-30" + irVersion: 18 + version: 0.7.5-rc1 +- changelogEntry: + - summary: Release 0.7.5-rc0 + type: chore + createdAt: "2023-04-28" + irVersion: 18 + version: 0.7.5-rc0 +- changelogEntry: + - summary: Release 0.7.4 + type: chore + createdAt: "2023-04-23" + irVersion: 18 + version: 0.7.4 +- changelogEntry: + - summary: Release 0.7.4-rc1 + type: chore + createdAt: "2023-04-23" + irVersion: 18 + version: 0.7.4-rc1 +- changelogEntry: + - summary: Release 0.7.4-rc0 + type: chore + createdAt: "2023-04-23" + irVersion: 18 + version: 0.7.4-rc0 +- changelogEntry: + - summary: Release 0.7.3 + type: chore + createdAt: "2023-04-23" + irVersion: 18 + version: 0.7.3 +- changelogEntry: + - summary: Release 0.7.3-rc0 + type: chore + createdAt: "2023-04-23" + irVersion: 18 + version: 0.7.3-rc0 +- changelogEntry: + - summary: Release 0.7.2 + type: chore + createdAt: "2023-04-23" + irVersion: 18 + version: 0.7.2 +- changelogEntry: + - summary: Release 0.7.1 + type: chore + createdAt: "2023-04-23" + irVersion: 18 + version: 0.7.1 +- changelogEntry: + - summary: Release 0.7.1-rc1 + type: chore + createdAt: "2023-04-23" + irVersion: 18 + version: 0.7.1-rc1 +- changelogEntry: + - summary: Release 0.7.1-rc0 + type: chore + createdAt: "2023-04-23" + irVersion: 18 + version: 0.7.1-rc0 +- changelogEntry: + - summary: Release 0.7.0 + type: chore + createdAt: "2023-04-21" + irVersion: 18 + version: 0.7.0 +- changelogEntry: + - summary: Release 0.7.0-rc1 + type: chore + createdAt: "2023-04-21" + irVersion: 18 + version: 0.7.0-rc1 +- changelogEntry: + - summary: Release 0.7.0-rc0 + type: chore + createdAt: "2023-04-21" + irVersion: 18 + version: 0.7.0-rc0 +- changelogEntry: + - summary: Release 0.6.12 + type: chore + createdAt: "2023-04-19" + irVersion: 18 + version: 0.6.12 +- changelogEntry: + - summary: Release 0.6.11 + type: chore + createdAt: "2023-04-19" + irVersion: 18 + version: 0.6.11 +- changelogEntry: + - summary: Release 0.6.11-rc2 + type: chore + createdAt: "2023-04-17" + irVersion: 18 + version: 0.6.11-rc2 +- changelogEntry: + - summary: Release 0.6.11-rc1 + type: chore + createdAt: "2023-04-17" + irVersion: 18 + version: 0.6.11-rc1 +- changelogEntry: + - summary: Release 0.6.11-rc0 + type: chore + createdAt: "2023-04-17" + irVersion: 18 + version: 0.6.11-rc0 +- changelogEntry: + - summary: Release 0.6.10 + type: chore + createdAt: "2023-04-04" + irVersion: 16 + version: 0.6.10 +- changelogEntry: + - summary: Release 0.6.10-rc4 + type: chore + createdAt: "2023-04-03" + irVersion: 16 + version: 0.6.10-rc4 +- changelogEntry: + - summary: Release 0.6.10-rc3 + type: chore + createdAt: "2023-04-03" + irVersion: 16 + version: 0.6.10-rc3 +- changelogEntry: + - summary: Release 0.6.10-rc2 + type: chore + createdAt: "2023-04-03" + irVersion: 16 + version: 0.6.10-rc2 +- changelogEntry: + - summary: Release 0.6.10-rc1 + type: chore + createdAt: "2023-04-02" + irVersion: 16 + version: 0.6.10-rc1 +- changelogEntry: + - summary: Release 0.6.10-rc0 + type: chore + createdAt: "2023-04-02" + irVersion: 16 + version: 0.6.10-rc0 +- changelogEntry: + - summary: Release 0.6.9 + type: chore + createdAt: "2023-04-02" + irVersion: 16 + version: 0.6.9 +- changelogEntry: + - summary: Release 0.6.8 + type: chore + createdAt: "2023-04-02" + irVersion: 16 + version: 0.6.8 +- changelogEntry: + - summary: Release 0.6.7 + type: chore + createdAt: "2023-04-01" + irVersion: 16 + version: 0.6.7 +- changelogEntry: + - summary: Release 0.6.7-rc0 + type: chore + createdAt: "2023-04-01" + irVersion: 16 + version: 0.6.7-rc0 +- changelogEntry: + - summary: Release 0.6.6 + type: chore + createdAt: "2023-03-31" + irVersion: 16 + version: 0.6.6 +- changelogEntry: + - summary: Release 0.6.5 + type: chore + createdAt: "2023-03-31" + irVersion: 16 + version: 0.6.5 +- changelogEntry: + - summary: Release 0.6.5-rc1 + type: chore + createdAt: "2023-03-31" + irVersion: 16 + version: 0.6.5-rc1 +- changelogEntry: + - summary: Release 0.6.5-rc0 + type: chore + createdAt: "2023-03-30" + irVersion: 16 + version: 0.6.5-rc0 +- changelogEntry: + - summary: Release 0.6.4 + type: chore + createdAt: "2023-03-30" + irVersion: 16 + version: 0.6.4 +- changelogEntry: + - summary: Release 0.6.3 + type: chore + createdAt: "2023-03-30" + irVersion: 16 + version: 0.6.3 +- changelogEntry: + - summary: Release 0.6.3-rc1 + type: chore + createdAt: "2023-03-30" + irVersion: 16 + version: 0.6.3-rc1 +- changelogEntry: + - summary: Release 0.6.3-rc0 + type: chore + createdAt: "2023-03-30" + irVersion: 16 + version: 0.6.3-rc0 +- changelogEntry: + - summary: Release 0.6.2 + type: chore + createdAt: "2023-03-29" + irVersion: 16 + version: 0.6.2 +- changelogEntry: + - summary: Release 0.6.2-rc2 + type: chore + createdAt: "2023-03-29" + irVersion: 16 + version: 0.6.2-rc2 +- changelogEntry: + - summary: Release 0.6.2-rc1 + type: chore + createdAt: "2023-03-29" + irVersion: 16 + version: 0.6.2-rc1 +- changelogEntry: + - summary: Release 0.6.2-rc0 + type: chore + createdAt: "2023-03-28" + irVersion: 16 + version: 0.6.2-rc0 +- changelogEntry: + - summary: Release 0.6.1 + type: chore + createdAt: "2023-03-28" + irVersion: 15 + version: 0.6.1 +- changelogEntry: + - summary: Release 0.6.0 + type: chore + createdAt: "2023-03-28" + irVersion: 15 + version: 0.6.0 +- changelogEntry: + - summary: Release 0.5.4 + type: chore + createdAt: "2023-03-28" + irVersion: 15 + version: 0.5.4 +- changelogEntry: + - summary: Release 0.5.4-rc4 + type: chore + createdAt: "2023-03-28" + irVersion: 15 + version: 0.5.4-rc4 +- changelogEntry: + - summary: Release 0.5.4-rc3 + type: chore + createdAt: "2023-03-26" + irVersion: 15 + version: 0.5.4-rc3 +- changelogEntry: + - summary: Release 0.5.4-rc2 + type: chore + createdAt: "2023-03-24" + irVersion: 15 + version: 0.5.4-rc2 +- changelogEntry: + - summary: Release 0.5.4-rc1 + type: chore + createdAt: "2023-03-24" + irVersion: 15 + version: 0.5.4-rc1 +- changelogEntry: + - summary: Release 0.5.4-rc0 + type: chore + createdAt: "2023-03-24" + irVersion: 15 + version: 0.5.4-rc0 +- changelogEntry: + - summary: Release 0.5.3 + type: chore + createdAt: "2023-03-20" + irVersion: 14 + version: 0.5.3 +- changelogEntry: + - summary: Release 0.5.3-rc6 + type: chore + createdAt: "2023-03-20" + irVersion: 14 + version: 0.5.3-rc6 +- changelogEntry: + - summary: Release 0.5.3-rc5 + type: chore + createdAt: "2023-03-19" + irVersion: 14 + version: 0.5.3-rc5 +- changelogEntry: + - summary: Release 0.5.3-rc4 + type: chore + createdAt: "2023-03-19" + irVersion: 14 + version: 0.5.3-rc4 +- changelogEntry: + - summary: Release 0.5.3-rc3 + type: chore + createdAt: "2023-03-13" + irVersion: 13 + version: 0.5.3-rc3 +- changelogEntry: + - summary: Release 0.5.3-rc2 + type: chore + createdAt: "2023-03-13" + irVersion: 13 + version: 0.5.3-rc2 +- changelogEntry: + - summary: Release 0.5.3-rc1 + type: chore + createdAt: "2023-03-11" + irVersion: 13 + version: 0.5.3-rc1 +- changelogEntry: + - summary: Release 0.5.3-rc0 + type: chore + createdAt: "2023-03-11" + irVersion: 13 + version: 0.5.3-rc0 +- changelogEntry: + - summary: Release 0.5.2 + type: chore + createdAt: "2023-03-10" + irVersion: 12 + version: 0.5.2 +- changelogEntry: + - summary: Release 0.5.1 + type: chore + createdAt: "2023-03-09" + irVersion: 12 + version: 0.5.1 +- changelogEntry: + - summary: "## What's Changed\r\n* Support http streams in responses by @zachkirsch\ + \ in https://github.com/fern-api/fern/pull/1365\r\n* fix: introduce undiscrminated\ + \ unions by @dsinghvi in https://github.com/fern-api/fern/pull/1367\r\n* Add\ + \ release blocker for undiscriminated unions by @zachkirsch in https://github.com/fern-api/fern/pull/1369\r\ + \n* Fix undiscriminated union rule by @zachkirsch in https://github.com/fern-api/fern/pull/1370\r\ + \n* Add file upload by @zachkirsch in https://github.com/fern-api/fern/pull/1366\r\ + \n* Rename property key to bodyProperty by @zachkirsch in https://github.com/fern-api/fern/pull/1371\r\ + \n* Add optional files by @zachkirsch in https://github.com/fern-api/fern/pull/1372\r\ + \n* ts generator versions above `0.5.0-rc0-6` use IR V12 by @dsinghvi in https://github.com/fern-api/fern/pull/1373\r\ + \n* Make File a reserved keyword in TS by @zachkirsch in https://github.com/fern-api/fern/pull/1374\r\ + \n* Add query-param stream condition by @zachkirsch in https://github.com/fern-api/fern/pull/1375\r\ + \n* fix: audiences works with subpackages and packages by @dsinghvi in https://github.com/fern-api/fern/pull/1376\r\ + \n* Fix docs in file properties by @zachkirsch in https://github.com/fern-api/fern/pull/1378\r\ + \n* Update import reference in OpenAPIMigrator by @TeisJayaswal in https://github.com/fern-api/fern/pull/1380\r\ + \n* fix: add missing `MovieId` type by @codebender828 in https://github.com/fern-api/fern/pull/1381\r\ + \n* Only disallow 'body' wrapper properties when there's a referenced request\ + \ body by @zachkirsch in https://github.com/fern-api/fern/pull/1382\r\n\r\n\ + ## New Contributors\r\n* @codebender828 made their first contribution in https://github.com/fern-api/fern/pull/1381\r\ + \n\r\n**Full Changelog**: https://github.com/fern-api/fern/compare/0.4.32...0.5.0" + type: chore + createdAt: "2023-03-09" + irVersion: 12 + version: 0.5.0 +- changelogEntry: + - summary: Release 0.4.33-rc7 + type: chore + createdAt: "2023-03-09" + irVersion: 12 + version: 0.4.33-rc7 +- changelogEntry: + - summary: Release 0.4.33-rc6 + type: chore + createdAt: "2023-03-09" + irVersion: 12 + version: 0.4.33-rc6 +- changelogEntry: + - summary: Release 0.4.33-rc5 + type: chore + createdAt: "2023-03-08" + irVersion: 12 + version: 0.4.33-rc5 +- changelogEntry: + - summary: Release 0.4.33-rc4 + type: chore + createdAt: "2023-03-08" + irVersion: 12 + version: 0.4.33-rc4 +- changelogEntry: + - summary: Release 0.4.33-rc3 + type: chore + createdAt: "2023-03-08" + irVersion: 12 + version: 0.4.33-rc3 +- changelogEntry: + - summary: Release 0.4.33-rc2 + type: chore + createdAt: "2023-03-08" + irVersion: 12 + version: 0.4.33-rc2 +- changelogEntry: + - summary: Release 0.4.33-rc1 + type: chore + createdAt: "2023-03-08" + irVersion: 12 + version: 0.4.33-rc1 +- changelogEntry: + - summary: Release 0.4.33-rc0 + type: chore + createdAt: "2023-03-07" + irVersion: 12 + version: 0.4.33-rc0 +- changelogEntry: + - summary: Release 0.4.32-rc5 + type: chore + createdAt: "2023-03-07" + irVersion: 12 + version: 0.4.32-rc5 +- changelogEntry: + - summary: Release 0.4.32 + type: chore + createdAt: "2023-03-06" + irVersion: 11 + version: 0.4.32 +- changelogEntry: + - summary: Release 0.4.32-rc4 + type: chore + createdAt: "2023-03-06" + irVersion: 11 + version: 0.4.32-rc4 +- changelogEntry: + - summary: Release 0.4.32-rc3 + type: chore + createdAt: "2023-03-06" + irVersion: 11 + version: 0.4.32-rc3 +- changelogEntry: + - summary: Release 0.4.32-rc2 + type: chore + createdAt: "2023-03-06" + irVersion: 11 + version: 0.4.32-rc2 +- changelogEntry: + - summary: Release 0.4.32-rc1 + type: chore + createdAt: "2023-03-06" + irVersion: 11 + version: 0.4.32-rc1 +- changelogEntry: + - summary: Release 0.4.32-rc0 + type: chore + createdAt: "2023-03-05" + irVersion: 9 + version: 0.4.32-rc0 +- changelogEntry: + - summary: Release 0.4.31-rc3 + type: chore + createdAt: "2023-03-04" + irVersion: 9 + version: 0.4.31-rc3 +- changelogEntry: + - summary: Release 0.4.31 + type: chore + createdAt: "2023-03-04" + irVersion: 9 + version: 0.4.31 +- changelogEntry: + - summary: Release 0.4.31-rc4 + type: chore + createdAt: "2023-03-04" + irVersion: 9 + version: 0.4.31-rc4 +- changelogEntry: + - summary: Release 0.4.31-rc2 + type: chore + createdAt: "2023-03-04" + irVersion: 9 + version: 0.4.31-rc2 +- changelogEntry: + - summary: Release 0.4.31-rc1 + type: chore + createdAt: "2023-03-04" + irVersion: 9 + version: 0.4.31-rc1 +- changelogEntry: + - summary: Release 0.4.30 + type: chore + createdAt: "2023-03-03" + irVersion: 9 + version: 0.4.30 +- changelogEntry: + - summary: Release 0.4.29 + type: chore + createdAt: "2023-03-03" + irVersion: 9 + version: 0.4.29 +- changelogEntry: + - summary: Release 0.4.28-rc4 + type: chore + createdAt: "2023-03-03" + irVersion: 9 + version: 0.4.28-rc4 +- changelogEntry: + - summary: Release 0.4.28-rc3 + type: chore + createdAt: "2023-03-03" + irVersion: 9 + version: 0.4.28-rc3 +- changelogEntry: + - summary: Release 0.4.28-rc2 + type: chore + createdAt: "2023-03-02" + irVersion: 9 + version: 0.4.28-rc2 +- changelogEntry: + - summary: Release 0.4.28-rc1 + type: chore + createdAt: "2023-03-02" + irVersion: 9 + version: 0.4.28-rc1 +- changelogEntry: + - summary: Release 0.4.28-rc0 + type: chore + createdAt: "2023-03-02" + irVersion: 9 + version: 0.4.28-rc0 +- changelogEntry: + - summary: Release 0.4.27-rc2 + type: chore + createdAt: "2023-03-02" + irVersion: 9 + version: 0.4.27-rc2 +- changelogEntry: + - summary: Release 0.4.27 + type: chore + createdAt: "2023-03-02" + irVersion: 9 + version: 0.4.27 +- changelogEntry: + - summary: Release 0.4.27-rc1 + type: chore + createdAt: "2023-03-02" + irVersion: 9 + version: 0.4.27-rc1 +- changelogEntry: + - summary: Release 0.4.27-rc0 + type: chore + createdAt: "2023-03-01" + irVersion: 9 + version: 0.4.27-rc0 +- changelogEntry: + - summary: Release 0.4.26 + type: chore + createdAt: "2023-02-25" + irVersion: 9 + version: 0.4.26 +- changelogEntry: + - summary: Release 0.4.25 + type: chore + createdAt: "2023-02-25" + irVersion: 9 + version: 0.4.25 +- changelogEntry: + - summary: Release 0.4.24 + type: chore + createdAt: "2023-02-23" + irVersion: 9 + version: 0.4.24 +- changelogEntry: + - summary: Release 0.4.24-rc1 + type: chore + createdAt: "2023-02-21" + irVersion: 9 + version: 0.4.24-rc1 +- changelogEntry: + - summary: Release 0.4.24-rc0 + type: chore + createdAt: "2023-02-20" + irVersion: 9 + version: 0.4.24-rc0 +- changelogEntry: + - summary: Release 0.4.23 + type: chore + createdAt: "2023-02-16" + irVersion: 8 + version: 0.4.23 +- changelogEntry: + - summary: Release 0.4.23-rc0 + type: chore + createdAt: "2023-02-16" + irVersion: 8 + version: 0.4.23-rc0 +- changelogEntry: + - summary: Release 0.4.22 + type: chore + createdAt: "2023-02-12" + irVersion: 8 + version: 0.4.22 +- changelogEntry: + - summary: Release 0.4.21 + type: chore + createdAt: "2023-02-12" + irVersion: 8 + version: 0.4.21 +- changelogEntry: + - summary: Release 0.4.20 + type: chore + createdAt: "2023-02-12" + irVersion: 8 + version: 0.4.20 +- changelogEntry: + - summary: Release 0.4.20-rc1 + type: chore + createdAt: "2023-02-09" + irVersion: 8 + version: 0.4.20-rc1 +- changelogEntry: + - summary: Release 0.4.20-rc0 + type: chore + createdAt: "2023-02-09" + irVersion: 8 + version: 0.4.20-rc0 +- changelogEntry: + - summary: Release 0.4.19-rc1 + type: chore + createdAt: "2023-02-09" + irVersion: 8 + version: 0.4.19-rc1 +- changelogEntry: + - summary: Release 0.4.19 + type: chore + createdAt: "2023-02-09" + irVersion: 8 + version: 0.4.19 +- changelogEntry: + - summary: Release 0.4.19-rc2 + type: chore + createdAt: "2023-02-09" + irVersion: 8 + version: 0.4.19-rc2 +- changelogEntry: + - summary: Release 0.4.19-rc0 + type: chore + createdAt: "2023-02-09" + irVersion: 8 + version: 0.4.19-rc0 +- changelogEntry: + - summary: Release 0.4.18 + type: chore + createdAt: "2023-02-07" + irVersion: 8 + version: 0.4.18 +- changelogEntry: + - summary: Release 0.4.17 + type: chore + createdAt: "2023-02-06" + irVersion: 8 + version: 0.4.17 +- changelogEntry: + - summary: Release 0.4.17-rc0 + type: chore + createdAt: "2023-02-06" + irVersion: 8 + version: 0.4.17-rc0 +- changelogEntry: + - summary: Release 0.4.16 + type: chore + createdAt: "2023-02-06" + irVersion: 8 + version: 0.4.16 +- changelogEntry: + - summary: Release 0.4.15 + type: chore + createdAt: "2023-02-06" + irVersion: 8 + version: 0.4.15 +- changelogEntry: + - summary: Release 0.4.15-rc0 + type: chore + createdAt: "2023-02-06" + irVersion: 8 + version: 0.4.15-rc0 +- changelogEntry: + - summary: Release 0.4.14 + type: chore + createdAt: "2023-02-05" + irVersion: 8 + version: 0.4.14 +- changelogEntry: + - summary: Release 0.4.13 + type: chore + createdAt: "2023-02-04" + irVersion: 8 + version: 0.4.13 +- changelogEntry: + - summary: Release 0.4.12 + type: chore + createdAt: "2023-02-02" + irVersion: 8 + version: 0.4.12 +- changelogEntry: + - summary: Release 0.4.12-rc0 + type: chore + createdAt: "2023-02-02" + irVersion: 8 + version: 0.4.12-rc0 +- changelogEntry: + - summary: Release 0.4.11 + type: chore + createdAt: "2023-02-02" + irVersion: 8 + version: 0.4.11 +- changelogEntry: + - summary: Release 0.4.11-rc1 + type: chore + createdAt: "2023-02-02" + irVersion: 8 + version: 0.4.11-rc1 +- changelogEntry: + - summary: Release 0.4.11-rc0 + type: chore + createdAt: "2023-02-02" + irVersion: 8 + version: 0.4.11-rc0 +- changelogEntry: + - summary: Release 0.4.10 + type: chore + createdAt: "2023-02-02" + irVersion: 8 + version: 0.4.10 +- changelogEntry: + - summary: Release 0.4.9 + type: chore + createdAt: "2023-02-01" + irVersion: 7 + version: 0.4.9 +- changelogEntry: + - summary: Release 0.4.8 + type: chore + createdAt: "2023-02-01" + irVersion: 7 + version: 0.4.8 +- changelogEntry: + - summary: Release 0.4.7 + type: chore + createdAt: "2023-02-01" + irVersion: 7 + version: 0.4.7 +- changelogEntry: + - summary: Release 0.4.6 + type: chore + createdAt: "2023-02-01" + irVersion: 7 + version: 0.4.6 +- changelogEntry: + - summary: Release 0.4.5 + type: chore + createdAt: "2023-02-01" + irVersion: 7 + version: 0.4.5 +- changelogEntry: + - summary: Release 0.4.5-rc4 + type: chore + createdAt: "2023-01-31" + irVersion: 7 + version: 0.4.5-rc4 +- changelogEntry: + - summary: Release 0.4.5-rc3 + type: chore + createdAt: "2023-01-31" + irVersion: 7 + version: 0.4.5-rc3 +- changelogEntry: + - summary: Release 0.4.5-rc5 + type: chore + createdAt: "2023-01-31" + irVersion: 7 + version: 0.4.5-rc5 +- changelogEntry: + - summary: Release 0.4.5-rc2 + type: chore + createdAt: "2023-01-30" + irVersion: 7 + version: 0.4.5-rc2 +- changelogEntry: + - summary: Release 0.4.5-rc1 + type: chore + createdAt: "2023-01-30" + irVersion: 7 + version: 0.4.5-rc1 +- changelogEntry: + - summary: Release 0.4.5-rc0 + type: chore + createdAt: "2023-01-30" + irVersion: 7 + version: 0.4.5-rc0 +- changelogEntry: + - summary: Release 0.4.4 + type: chore + createdAt: "2023-01-30" + irVersion: 7 + version: 0.4.4 +- changelogEntry: + - summary: Release 0.4.3 + type: chore + createdAt: "2023-01-30" + irVersion: 7 + version: 0.4.3 +- changelogEntry: + - summary: Release 0.4.2 + type: chore + createdAt: "2023-01-30" + irVersion: 7 + version: 0.4.2 +- changelogEntry: + - summary: Release 0.4.1 + type: chore + createdAt: "2023-01-29" + irVersion: 7 + version: 0.4.1 +- changelogEntry: + - summary: Release 0.4.0-rc1 + type: chore + createdAt: "2023-01-29" + irVersion: 7 + version: 0.4.0-rc1 +- changelogEntry: + - summary: Release 0.4.0 + type: chore + createdAt: "2023-01-29" + irVersion: 7 + version: 0.4.0 +- changelogEntry: + - summary: Release 0.4.0-rc0 + type: chore + createdAt: "2023-01-29" + irVersion: 7 + version: 0.4.0-rc0 +- changelogEntry: + - summary: Release 0.3.23 + type: chore + createdAt: "2023-01-28" + irVersion: 6 + version: 0.3.23 +- changelogEntry: + - summary: Release 0.3.22 + type: chore + createdAt: "2023-01-28" + irVersion: 6 + version: 0.3.22 +- changelogEntry: + - summary: Release 0.3.21 + type: chore + createdAt: "2023-01-28" + irVersion: 6 + version: 0.3.21 +- changelogEntry: + - summary: Release 0.3.20 + type: chore + createdAt: "2023-01-27" + irVersion: 6 + version: 0.3.20 +- changelogEntry: + - summary: Release 0.3.19 + type: chore + createdAt: "2023-01-24" + irVersion: 6 + version: 0.3.19 +- changelogEntry: + - summary: Release 0.3.18 + type: chore + createdAt: "2023-01-23" + irVersion: 6 + version: 0.3.18 +- changelogEntry: + - summary: Release 0.3.17 + type: chore + createdAt: "2023-01-23" + irVersion: 6 + version: 0.3.17 +- changelogEntry: + - summary: Release 0.3.17-rc8 + type: chore + createdAt: "2023-01-23" + irVersion: 6 + version: 0.3.17-rc8 +- changelogEntry: + - summary: Release 0.3.17-rc7 + type: chore + createdAt: "2023-01-23" + irVersion: 6 + version: 0.3.17-rc7 +- changelogEntry: + - summary: Release 0.3.17-rc6 + type: chore + createdAt: "2023-01-23" + irVersion: 6 + version: 0.3.17-rc6 +- changelogEntry: + - summary: Release 0.3.17-rc5 + type: chore + createdAt: "2023-01-23" + irVersion: 6 + version: 0.3.17-rc5 +- changelogEntry: + - summary: Release 0.3.17-rc4 + type: chore + createdAt: "2023-01-23" + irVersion: 6 + version: 0.3.17-rc4 +- changelogEntry: + - summary: Release 0.3.17-rc3 + type: chore + createdAt: "2023-01-23" + irVersion: 6 + version: 0.3.17-rc3 +- changelogEntry: + - summary: Release 0.3.17-rc2 + type: chore + createdAt: "2023-01-22" + irVersion: 6 + version: 0.3.17-rc2 +- changelogEntry: + - summary: Release 0.3.17-rc1 + type: chore + createdAt: "2023-01-21" + irVersion: 6 + version: 0.3.17-rc1 +- changelogEntry: + - summary: Release 0.3.17-rc0 + type: chore + createdAt: "2023-01-21" + irVersion: 6 + version: 0.3.17-rc0 +- changelogEntry: + - summary: Release 0.3.16 + type: chore + createdAt: "2023-01-20" + irVersion: 6 + version: 0.3.16 +- changelogEntry: + - summary: Release 0.3.16-rc2 + type: chore + createdAt: "2023-01-19" + irVersion: 6 + version: 0.3.16-rc2 +- changelogEntry: + - summary: Release 0.3.16-rc1 + type: chore + createdAt: "2023-01-18" + irVersion: 6 + version: 0.3.16-rc1 +- changelogEntry: + - summary: Release 0.3.16-rc0 + type: chore + createdAt: "2023-01-18" + irVersion: 6 + version: 0.3.16-rc0 +- changelogEntry: + - summary: Release 0.3.15 + type: chore + createdAt: "2023-01-18" + irVersion: 6 + version: 0.3.15 +- changelogEntry: + - summary: Release 0.3.15-rc0 + type: chore + createdAt: "2023-01-18" + irVersion: 6 + version: 0.3.15-rc0 +- changelogEntry: + - summary: Release 0.3.14 + type: chore + createdAt: "2023-01-18" + irVersion: 6 + version: 0.3.14 +- changelogEntry: + - summary: Release 0.3.13 + type: chore + createdAt: "2023-01-18" + irVersion: 6 + version: 0.3.13 +- changelogEntry: + - summary: Release 0.3.12 + type: chore + createdAt: "2023-01-18" + irVersion: 6 + version: 0.3.12 +- changelogEntry: + - summary: Release 0.3.12-rc13 + type: chore + createdAt: "2023-01-18" + irVersion: 6 + version: 0.3.12-rc13 +- changelogEntry: + - summary: Release 0.3.12-rc12 + type: chore + createdAt: "2023-01-18" + irVersion: 6 + version: 0.3.12-rc12 +- changelogEntry: + - summary: Release 0.3.12-rc9 + type: chore + createdAt: "2023-01-17" + irVersion: 6 + version: 0.3.12-rc9 +- changelogEntry: + - summary: Release 0.3.12-rc8 + type: chore + createdAt: "2023-01-17" + irVersion: 6 + version: 0.3.12-rc8 +- changelogEntry: + - summary: Release 0.3.12-rc11 + type: chore + createdAt: "2023-01-17" + irVersion: 6 + version: 0.3.12-rc11 +- changelogEntry: + - summary: Release 0.3.12-rc10 + type: chore + createdAt: "2023-01-17" + irVersion: 6 + version: 0.3.12-rc10 +- changelogEntry: + - summary: Release 0.3.12-rc7 + type: chore + createdAt: "2023-01-15" + irVersion: 6 + version: 0.3.12-rc7 +- changelogEntry: + - summary: Release 0.3.12-rc6 + type: chore + createdAt: "2023-01-15" + irVersion: 6 + version: 0.3.12-rc6 +- changelogEntry: + - summary: Release 0.3.12-rc5 + type: chore + createdAt: "2023-01-15" + irVersion: 6 + version: 0.3.12-rc5 +- changelogEntry: + - summary: Release 0.3.12-rc4 + type: chore + createdAt: "2023-01-15" + irVersion: 6 + version: 0.3.12-rc4 +- changelogEntry: + - summary: Release 0.3.12-rc3 + type: chore + createdAt: "2023-01-13" + irVersion: 5 + version: 0.3.12-rc3 +- changelogEntry: + - summary: Release 0.3.12-rc2 + type: chore + createdAt: "2023-01-13" + irVersion: 5 + version: 0.3.12-rc2 +- changelogEntry: + - summary: Release 0.3.12-rc1 + type: chore + createdAt: "2023-01-13" + irVersion: 5 + version: 0.3.12-rc1 +- changelogEntry: + - summary: Release 0.3.12-rc0 + type: chore + createdAt: "2023-01-12" + irVersion: 5 + version: 0.3.12-rc0 +- changelogEntry: + - summary: Release 0.3.11 + type: chore + createdAt: "2023-01-12" + irVersion: 5 + version: 0.3.11 +- changelogEntry: + - summary: Release 0.3.10 + type: chore + createdAt: "2023-01-11" + irVersion: 5 + version: 0.3.10 +- changelogEntry: + - summary: Release 0.3.9 + type: chore + createdAt: "2023-01-11" + irVersion: 5 + version: 0.3.9 +- changelogEntry: + - summary: Release 0.3.8-rc1 + type: chore + createdAt: "2023-01-11" + irVersion: 5 + version: 0.3.8-rc1 +- changelogEntry: + - summary: Release 0.3.8-rc0 + type: chore + createdAt: "2023-01-11" + irVersion: 5 + version: 0.3.8-rc0 +- changelogEntry: + - summary: Release 0.3.8 + type: chore + createdAt: "2023-01-09" + irVersion: 5 + version: 0.3.8 +- changelogEntry: + - summary: Release 0.3.7 + type: chore + createdAt: "2023-01-08" + irVersion: 5 + version: 0.3.7 +- changelogEntry: + - summary: Release 0.3.7-rc0 + type: chore + createdAt: "2023-01-08" + irVersion: 5 + version: 0.3.7-rc0 +- changelogEntry: + - summary: Release 0.3.6 + type: chore + createdAt: "2023-01-08" + irVersion: 5 + version: 0.3.6 +- changelogEntry: + - summary: Release 0.3.6-rc1 + type: chore + createdAt: "2023-01-06" + irVersion: 4 + version: 0.3.6-rc1 +- changelogEntry: + - summary: Release 0.3.6-rc0 + type: chore + createdAt: "2023-01-06" + irVersion: 4 + version: 0.3.6-rc0 +- changelogEntry: + - summary: Release 0.3.5 + type: chore + createdAt: "2022-12-28" + irVersion: 4 + version: 0.3.5 +- changelogEntry: + - summary: Release 0.3.4 + type: chore + createdAt: "2022-12-28" + irVersion: 4 + version: 0.3.4 +- changelogEntry: + - summary: Release 0.3.3 + type: chore + createdAt: "2022-12-28" + irVersion: 4 + version: 0.3.3 +- changelogEntry: + - summary: Release 0.3.2 + type: chore + createdAt: "2022-12-28" + irVersion: 4 + version: 0.3.2 +- changelogEntry: + - summary: Release 0.3.1 + type: chore + createdAt: "2022-12-28" + irVersion: 4 + version: 0.3.1 +- changelogEntry: + - summary: Release 0.3.0-rc14 + type: chore + createdAt: "2022-12-28" + irVersion: 4 + version: 0.3.0-rc14 +- changelogEntry: + - summary: Release 0.3.0-rc13 + type: chore + createdAt: "2022-12-28" + irVersion: 4 + version: 0.3.0-rc13 +- changelogEntry: + - summary: Release 0.3.0 + type: chore + createdAt: "2022-12-28" + irVersion: 4 + version: 0.3.0 +- changelogEntry: + - summary: Release 0.3.0-rc12 + type: chore + createdAt: "2022-12-24" + irVersion: 4 + version: 0.3.0-rc12 +- changelogEntry: + - summary: Release 0.3.0-rc11 + type: chore + createdAt: "2022-12-23" + irVersion: 4 + version: 0.3.0-rc11 +- changelogEntry: + - summary: Release 0.3.0-rc9 + type: chore + createdAt: "2022-12-16" + irVersion: 4 + version: 0.3.0-rc9 +- changelogEntry: + - summary: Release 0.3.0-rc8 + type: chore + createdAt: "2022-12-16" + irVersion: 4 + version: 0.3.0-rc8 +- changelogEntry: + - summary: Release 0.3.0-rc7 + type: chore + createdAt: "2022-12-16" + irVersion: 4 + version: 0.3.0-rc7 +- changelogEntry: + - summary: Release 0.3.0-rc10 + type: chore + createdAt: "2022-12-16" + irVersion: 4 + version: 0.3.0-rc10 +- changelogEntry: + - summary: Release 0.3.0-rc6 + type: chore + createdAt: "2022-12-16" + irVersion: 4 + version: 0.3.0-rc6 +- changelogEntry: + - summary: Release 0.3.0-rc5 + type: chore + createdAt: "2022-12-16" + irVersion: 4 + version: 0.3.0-rc5 +- changelogEntry: + - summary: Release 0.3.0-rc4 + type: chore + createdAt: "2022-12-16" + irVersion: 4 + version: 0.3.0-rc4 +- changelogEntry: + - summary: Release 0.3.0-rc3 + type: chore + createdAt: "2022-12-16" + irVersion: 4 + version: 0.3.0-rc3 +- changelogEntry: + - summary: Release 0.3.0-rc2 + type: chore + createdAt: "2022-12-16" + irVersion: 4 + version: 0.3.0-rc2 +- changelogEntry: + - summary: Release 0.3.0-rc1 + type: chore + createdAt: "2022-12-16" + irVersion: 4 + version: 0.3.0-rc1 +- changelogEntry: + - summary: Release 0.3.0-rc0 + type: chore + createdAt: "2022-12-15" + irVersion: 3 + version: 0.3.0-rc0 +- changelogEntry: + - summary: Release 0.2.1 + type: chore + createdAt: "2022-12-15" + irVersion: 3 + version: 0.2.1 +- changelogEntry: + - summary: Release 0.2.0 + type: chore + createdAt: "2022-12-14" + irVersion: 3 + version: 0.2.0 +- changelogEntry: + - summary: Release 0.1.3-rc9 + type: chore + createdAt: "2022-12-14" + irVersion: 3 + version: 0.1.3-rc9 +- changelogEntry: + - summary: Release 0.1.3-rc8 + type: chore + createdAt: "2022-12-14" + irVersion: 3 + version: 0.1.3-rc8 +- changelogEntry: + - summary: Release 0.1.3-rc7 + type: chore + createdAt: "2022-12-13" + irVersion: 3 + version: 0.1.3-rc7 +- changelogEntry: + - summary: Release 0.1.3-rc6 + type: chore + createdAt: "2022-12-13" + irVersion: 3 + version: 0.1.3-rc6 +- changelogEntry: + - summary: Release 0.1.3-rc5 + type: chore + createdAt: "2022-12-13" + irVersion: 3 + version: 0.1.3-rc5 +- changelogEntry: + - summary: Release 0.1.3-rc4 + type: chore + createdAt: "2022-12-13" + irVersion: 3 + version: 0.1.3-rc4 +- changelogEntry: + - summary: Release 0.1.3-rc3 + type: chore + createdAt: "2022-12-13" + irVersion: 3 + version: 0.1.3-rc3 +- changelogEntry: + - summary: Release 0.1.3-rc2 + type: chore + createdAt: "2022-12-13" + irVersion: 3 + version: 0.1.3-rc2 +- changelogEntry: + - summary: Release 0.1.3-rc1 + type: chore + createdAt: "2022-12-13" + irVersion: 3 + version: 0.1.3-rc1 +- changelogEntry: + - summary: Release 0.1.3-rc0 + type: chore + createdAt: "2022-12-13" + irVersion: 3 + version: 0.1.3-rc0 diff --git a/packages/parsers/src/openapi/__test__/fixtures/rules/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/rules/openapi.yml new file mode 100644 index 0000000000..9e00091455 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/rules/openapi.yml @@ -0,0 +1,66 @@ +openapi: 3.0.0 +info: + title: Sample API + version: 1.0.0 +paths: + /example: + get: + summary: Default and validation rules + responses: + '200': + description: Successful response + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/Schema" + - type: object + properties: + message: + type: string +components: + schemas: + String: + type: string + default: fern + minLength: 3 + maxLength: 10 + pattern: "^[a-zA-Z0-9]*$" + format: custom + Schema: + type: object + properties: + id: + description: The unique ID of the type. + type: integer + default: 50 + minimum: 10 + maximum: 100 + exclusiveMinimum: true + exclusiveMaximum: false + multipleOf: 10 + age: + description: The age of the type. + type: integer + default: 50 + minimum: -2147483649 # outside of min int + maximum: 2147483648 # outside of max int + exclusiveMinimum: true + exclusiveMaximum: false + multipleOf: 10 + name: + description: The unique name of the type. + type: string + default: type + minLength: 3 + maxLength: 10 + pattern: "^[a-zA-Z0-9]*$" + format: custom + value: + description: The value of the type. + type: number + format: double + default: 1.1 + minimum: 1.1 + maximum: 2.2 + multipleOf: 1.1 diff --git a/packages/parsers/src/openapi/__test__/fixtures/streaming/StreamUser.yml b/packages/parsers/src/openapi/__test__/fixtures/streaming/StreamUser.yml new file mode 100644 index 0000000000..1f838fe918 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/streaming/StreamUser.yml @@ -0,0 +1,10 @@ +type: object +properties: + id: + type: string + format: uuid + name: + type: string + streamed: + x-fern-boolean-literal: true + type: boolean diff --git a/packages/parsers/src/openapi/__test__/fixtures/streaming/User.yml b/packages/parsers/src/openapi/__test__/fixtures/streaming/User.yml new file mode 100644 index 0000000000..4abfa561e3 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/streaming/User.yml @@ -0,0 +1,10 @@ +type: object +properties: + id: + type: string + format: uuid + name: + type: string + streamed: + x-fern-boolean-literal: false + type: boolean diff --git a/packages/parsers/src/openapi/__test__/fixtures/streaming/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/streaming/openapi.yml new file mode 100644 index 0000000000..7a7eed085f --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/streaming/openapi.yml @@ -0,0 +1,108 @@ +openapi: 3.0.3 +info: + title: Streaming API + version: 1.0.0 +paths: + /v1/users: + post: + operationId: user + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + description: "" + type: string + x-fern-streaming: + stream-condition: $request.stream + response: + $ref: "#/components/schemas/User" + response-stream: + $ref: "#/components/schemas/StreamUser" + responses: + "200": + description: "" + content: + application/json: + schema: + $ref: "#/components/schemas/User" + /v2/users: + post: + operationId: user_v2 + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + description: "" + type: string + x-fern-streaming: + stream-condition: $request.stream + response: + $ref: "./User.yml" + response-stream: + $ref: "./StreamUser.yml" + responses: + "200": + description: "" + content: + application/json: + schema: + $ref: "#/components/schemas/User" + /v3/users: + post: + operationId: user_v3 + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + description: "" + type: string + x-fern-streaming: + stream-condition: $request.stream + response: + type: object + properties: + id: + type: string + format: uuid + inline: + type: boolean + response-stream: + type: object + properties: + id: + type: string + format: uuid + inline: + type: boolean + streamed: + type: boolean + responses: + "200": + description: "" + content: + application/json: + schema: + $ref: "#/components/schemas/User" +components: + schemas: + User: + type: object + properties: + id: + type: string + format: uuid + StreamUser: + type: object + properties: + id: + type: string + format: uuid diff --git a/packages/parsers/src/openapi/__test__/fixtures/uint/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/uint/openapi.yml new file mode 100644 index 0000000000..e0f2a21ab9 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/uint/openapi.yml @@ -0,0 +1,47 @@ +openapi: 3.0.3 +info: + title: Test spec for `uint` types specified as number formats. + version: 1.0.0 + +paths: + /get: + get: + operationId: Get + requestBody: + required: true + description: A simple API request. + content: + application/json: + schema: + $ref: "#/components/schemas/Request" + responses: + '200': + description: A simple API response. + content: + application/json: + schema: + $ref: "#/components/schemas/Response" + +components: + schemas: + Request: + description: | + A generic request type used throughout the API. + properties: + id: + type: number + format: uint + value: + type: number + format: uint64 + + Response: + description: | + A generic response type used throughout the API. + properties: + id: + type: number + format: uint + value: + type: number + format: uint64 \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/union-extension/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/union-extension/openapi.yml new file mode 100644 index 0000000000..a130873051 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/union-extension/openapi.yml @@ -0,0 +1,45 @@ +openapi: 3.0.3 +info: + title: Test inheritance from undiscrimnated union objects + version: 1.0.0 +paths: {} +components: + schemas: + PartyAccount: + type: object + description: PartyAccount with excluded currency in response + oneOf: + - $ref: "#/components/schemas/IbanField" + - $ref: "#/components/schemas/OtherField" + + IbanField: + type: object + properties: + iban: + nullable: true + type: string + example: DE2310010010123456788 + + OtherField: + type: object + properties: + other: + nullable: true + $ref: "#/components/schemas/Other" + + Other: + type: object + properties: + identification: + type: string + schemeNameCone: + type: string + + CounterPartyAccount: + properties: + currency: + type: string + example: EUR + allOf: + - $ref: "#/components/schemas/PartyAccount" + - type: object diff --git a/packages/parsers/src/openapi/__test__/fixtures/unions-v1/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/unions-v1/openapi.yml new file mode 100644 index 0000000000..fb0966886e --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/unions-v1/openapi.yml @@ -0,0 +1,39 @@ +openapi: 3.0.3 +info: + title: Test setting to disable usage of title param + version: 1.0.0 +paths: {} +components: + schemas: + Shape: + type: object + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/Triangle' + - $ref: '#/components/schemas/Square' + Triangle: + type: object + properties: + type: + type: string + enum: ["triangle"] + base: + type: number + height: + type: number + required: + - type + - base + - height + Square: + type: object + properties: + type: + type: string + enum: ["square"] + sideLength: + type: number + required: + - type + - sideLength \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/use-title-false/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/use-title-false/openapi.yml new file mode 100644 index 0000000000..5c1f60114a --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/use-title-false/openapi.yml @@ -0,0 +1,187 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Hume AI Batch API", + "description": "The Batch API provides access to Hume models through an asynchronous job-based interface. You can submit a job to have many different files processed in parallel. The status of a job can then be checked with the job ID. Email notifications are available to alert on completed jobs.", + "version": "0.1.0" + }, + "paths": {}, + "components": { + "schemas": { + "UnionJob": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/UnionJob_Job" + }, + { + "$ref": "#/components/schemas/UnionJob_Job" + }, + { + "$ref": "#/components/schemas/UnionJob_Job" + }, + { + "$ref": "#/components/schemas/UnionJob_Job" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "EMBEDDING_GENERATION": "#/components/schemas/UnionJob_Job", + "INFERENCE": "#/components/schemas/UnionJob_Job", + "TL_INFERENCE": "#/components/schemas/UnionJob_Job", + "TRAINING": "#/components/schemas/UnionJob_Job" + } + } + } + }, + "UnionJob_Job": { + "allOf": [ + { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "example": "EMBEDDING_GENERATION" + } + } + }, + { + "$ref": "#/components/schemas/Job" + } + ] + }, + "UnionJob_Job": { + "allOf": [ + { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "example": "INFERENCE" + } + } + }, + { + "$ref": "#/components/schemas/Job" + } + ] + }, + "UnionJob_Job": { + "allOf": [ + { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "example": "TL_INFERENCE" + } + } + }, + { + "$ref": "#/components/schemas/Job" + } + ] + }, + "UnionJob_Job": { + "allOf": [ + { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "example": "TRAINING" + } + } + }, + { + "$ref": "#/components/schemas/Job" + } + ] + }, + "Job": { + "type": "object", + "required": [ + "job_id", + "user_id" + ], + "properties": { + "job_id": { + "type": "string", + "format": "uuid", + "description": "The ID associated with this job." + }, + "user_id": { + "type": "string", + "format": "uuid" + } + } + }, + "Job": { + "type": "object", + "required": [ + "job_id", + "user_id" + ], + "properties": { + "job_id": { + "type": "string", + "format": "uuid", + "description": "The ID associated with this job." + }, + "user_id": { + "type": "string", + "format": "uuid" + } + } + }, + "Job": { + "type": "object", + "required": [ + "job_id", + "user_id" + ], + "properties": { + "job_id": { + "type": "string", + "format": "uuid", + "description": "The ID associated with this job." + }, + "user_id": { + "type": "string", + "format": "uuid" + } + } + }, + "Job": { + "type": "object", + "required": [ + "job_id", + "user_id" + ], + "properties": { + "job_id": { + "type": "string", + "format": "uuid", + "description": "The ID associated with this job." + }, + "user_id": { + "type": "string", + "format": "uuid" + } + } + } + } +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/use-title-true/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/use-title-true/openapi.yml new file mode 100644 index 0000000000..5c1f60114a --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/use-title-true/openapi.yml @@ -0,0 +1,187 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Hume AI Batch API", + "description": "The Batch API provides access to Hume models through an asynchronous job-based interface. You can submit a job to have many different files processed in parallel. The status of a job can then be checked with the job ID. Email notifications are available to alert on completed jobs.", + "version": "0.1.0" + }, + "paths": {}, + "components": { + "schemas": { + "UnionJob": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/UnionJob_Job" + }, + { + "$ref": "#/components/schemas/UnionJob_Job" + }, + { + "$ref": "#/components/schemas/UnionJob_Job" + }, + { + "$ref": "#/components/schemas/UnionJob_Job" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "EMBEDDING_GENERATION": "#/components/schemas/UnionJob_Job", + "INFERENCE": "#/components/schemas/UnionJob_Job", + "TL_INFERENCE": "#/components/schemas/UnionJob_Job", + "TRAINING": "#/components/schemas/UnionJob_Job" + } + } + } + }, + "UnionJob_Job": { + "allOf": [ + { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "example": "EMBEDDING_GENERATION" + } + } + }, + { + "$ref": "#/components/schemas/Job" + } + ] + }, + "UnionJob_Job": { + "allOf": [ + { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "example": "INFERENCE" + } + } + }, + { + "$ref": "#/components/schemas/Job" + } + ] + }, + "UnionJob_Job": { + "allOf": [ + { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "example": "TL_INFERENCE" + } + } + }, + { + "$ref": "#/components/schemas/Job" + } + ] + }, + "UnionJob_Job": { + "allOf": [ + { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "example": "TRAINING" + } + } + }, + { + "$ref": "#/components/schemas/Job" + } + ] + }, + "Job": { + "type": "object", + "required": [ + "job_id", + "user_id" + ], + "properties": { + "job_id": { + "type": "string", + "format": "uuid", + "description": "The ID associated with this job." + }, + "user_id": { + "type": "string", + "format": "uuid" + } + } + }, + "Job": { + "type": "object", + "required": [ + "job_id", + "user_id" + ], + "properties": { + "job_id": { + "type": "string", + "format": "uuid", + "description": "The ID associated with this job." + }, + "user_id": { + "type": "string", + "format": "uuid" + } + } + }, + "Job": { + "type": "object", + "required": [ + "job_id", + "user_id" + ], + "properties": { + "job_id": { + "type": "string", + "format": "uuid", + "description": "The ID associated with this job." + }, + "user_id": { + "type": "string", + "format": "uuid" + } + } + }, + "Job": { + "type": "object", + "required": [ + "job_id", + "user_id" + ], + "properties": { + "job_id": { + "type": "string", + "format": "uuid", + "description": "The ID associated with this job." + }, + "user_id": { + "type": "string", + "format": "uuid" + } + } + } + } +} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/webhooks/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/webhooks/openapi.yml new file mode 100644 index 0000000000..32843d95a0 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/webhooks/openapi.yml @@ -0,0 +1,36 @@ +openapi: 3.1.0 +info: + title: Webhooks + version: 1.0.0 +webhooks: + /pet: + post: + operationId: CreatePet + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/Pet" + examples: + Example 1: + value: + id: 123 + name: "Scratch" + tag: "Cat" + responses: + "200": + description: Return a 200 status to indicate that the data was received successfully +components: + schemas: + Pet: + required: + - id + - name + properties: + id: + type: integer + format: int64 + name: + type: string + tag: + type: string \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-audiences/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-audiences/openapi.yml new file mode 100644 index 0000000000..3caa494605 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-audiences/openapi.yml @@ -0,0 +1,34 @@ +openapi: 3.0.3 +info: + title: Test extension `x-fern-audiences` + version: 1.0.0 +servers: + - url: https://api.com + x-fern-server-name: production + x-fern-audiences: [ "public" ] + - url: https://private.api.com + x-fern-server-name: sandbox + x-fern-audiences: [ "private" ] +paths: + /v1/users: + post: + requestBody: + content: + application/json: + schema: + type: object + properties: + public_property: + type: string + x-fern-audiences: [ "public" ] + private_property: + type: string +components: + schemas: + BaseUser: + type: object + properties: + id: + type: string + format: uuid + x-fern-audiences: [ "public" ] diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-auth-variables/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-auth-variables/openapi.yml new file mode 100644 index 0000000000..23e8d07fc0 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-auth-variables/openapi.yml @@ -0,0 +1,50 @@ +openapi: 3.1.0 +info: + title: Test extension `x-fern-parameter-name` for parameters. + version: 1.0.0 +paths: + /user: + get: + x-fern-sdk-group-name: ["user"] + x-fern-sdk-method-name: ["get"] + responses: + "200": + description: "Success" + content: + application/json: + schema: + type: object + properties: + id: + type: string + format: uuid + /users: + get: + x-fern-sdk-group-name: ["user"] + x-fern-sdk-method-name: ["get_all"] + responses: + "200": + description: "Success" + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + +components: + securitySchemes: + BasicAuth: + type: http + scheme: basic + x-fern-basic: + username: + name: username + env: MY_USERNAME + password: + name: password + env: MY_PaSSwoOD diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-base-path/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-base-path/openapi.yml new file mode 100644 index 0000000000..29b92ce22b --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-base-path/openapi.yml @@ -0,0 +1,9 @@ +openapi: 3.0.0 +info: + title: Acme API + version: '1.0' + description: The Acme API. +servers: + - url: https://api.acme.com +x-fern-base-path: /v1 +paths: {} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-base-path/swagger.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-base-path/swagger.yml new file mode 100644 index 0000000000..babccd4b26 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-base-path/swagger.yml @@ -0,0 +1,14 @@ +swagger: '2.0' +info: + title: Acme API + version: '1.0' + description: The Acme API. +basePath: https://api.acme.com +x-fern-base-path: /v1 +paths: + /example: + get: + summary: Example endpoint + responses: + 200: + description: Successful response diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-encoding/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-encoding/openapi.yml new file mode 100644 index 0000000000..cdd6415fb2 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-encoding/openapi.yml @@ -0,0 +1,27 @@ +openapi: 3.0.3 +info: + title: Test extension `x-fern-encoding` for schemas + version: 1.0.0 +paths: {} +components: + schemas: + Metadata: + type: object + additionalProperties: + $ref: '#/components/schemas/MetadataValue' + x-fern-encoding: + proto: + type: google.protobuf.Struct + MetadataValue: + nullable: true + oneOf: + - type: number + format: double + - type: string + - type: boolean + - type: array + items: + $ref: '#/components/schemas/Value' + x-fern-encoding: + proto: + type: google.protobuf.Value diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-enum/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-enum/openapi.yml new file mode 100644 index 0000000000..cd1411e954 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-enum/openapi.yml @@ -0,0 +1,17 @@ +openapi: 3.1.0 +info: + title: Test extension `x-fern-enum` for enums + version: 1.0.0 +paths: {} +components: + schemas: + SpeechModel: + type: string + description: The speech model to use for the transcription. + x-fern-sdk-group-name: transcripts + enum: + - nano + x-fern-enum: + nano: + name: Nano + description: The Nano tier is a lightweight model that is optimized for speed and cost. \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-global-headers/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-global-headers/openapi.yml new file mode 100644 index 0000000000..ad345e8cba --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-global-headers/openapi.yml @@ -0,0 +1,95 @@ +openapi: 3.1.0 +info: + title: Test extension `x-fern-audiences` alongside `x-fern-streaming`. + version: 1.0.0 +x-fern-version: + header: my-api-version + default: '1.0' + values: + - '1.0' + - 'latest' +x-fern-global-headers: + - header: my-api-key + name: api-key-alias + optional: true + - header: another_header + optional: false + env: MY_HEADER_ENV + - header: version + name: Square-Version + env: SQUARE_VERSION + type: literal<"2024-06-04"> +paths: + "/user/{userId}": + post: + x-fern-sdk-group-name: user + x-fern-sdk-method-name: get + x-fern-streaming: + stream-condition: $request.stream + response: + $ref: "#/components/schemas/User" + response-stream: + $ref: "#/components/schemas/StreamUser" + operationId: get + parameters: + - in: path + name: userId + schema: + type: string + required: true + - in: header + name: my-api-key + schema: + type: string + required: true + - in: header + name: another_header + schema: + type: string + required: true + - in: header + name: x-api-key + schema: + type: string + required: true + - in: header + name: my-api-version + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + type: object + properties: + stream: + type: boolean + x-fern-audiences: [ "public" ] + responses: + "200": + description: "Success!" + content: + application/json: + schema: + type: string +components: + schemas: + User: + type: object + properties: + id: + type: string + format: uuid + streamed: + x-fern-type: literal + type: boolean + StreamUser: + type: object + properties: + id: + type: string + format: uuid + streamed: + x-fern-type: literal + type: boolean diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-idempotency-headers/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-idempotency-headers/openapi.yml new file mode 100644 index 0000000000..93bcad0168 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-idempotency-headers/openapi.yml @@ -0,0 +1,29 @@ +openapi: 3.1.0 +info: + title: Test extension `x-fern-audiences` alongside `x-fern-streaming`. + version: 1.0.0 +x-fern-idempotency-headers: + - header: Idempotency-Key +paths: + "/send": + post: + x-fern-sdk-method-name: send + x-fern-idempotent: true + requestBody: + content: + application/json: + schema: + type: object + properties: + send: + type: boolean + x-fern-audiences: [ "public" ] + responses: + "200": + description: "Success!" + content: + application/json: + schema: + type: string +components: + schemas: {} \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-ignore/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-ignore/openapi.yml new file mode 100644 index 0000000000..22a9fa0030 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-ignore/openapi.yml @@ -0,0 +1,63 @@ +openapi: 3.0.3 +info: + title: Test extension `x-fern-ignore` + version: 1.0.0 +paths: + /list: + get: + operationId: list + summary: List + description: "" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UsersResponse" + parameters: + - in: query + name: pageNumber + schema: + type: integer + - in: query + name: limit + schema: + type: integer + - in: query + name: ignoredParam1 + schema: + type: string + x-fern-ignore: true + - in: query + name: ignoredParam2 + schema: + type: string + x-fern-ignore: true +components: + schemas: + Meta: + properties: + hasMore: + type: boolean + UsersResponse: + type: object + properties: + meta: + $ref: "#/components/schemas/Meta" + users: + type: array + items: + $ref: "#/components/schemas/User" + User: + type: object + properties: + id: + type: string + format: uuid + name: + type: string + email: + type: string + age: + type: integer \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-pagination/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-pagination/openapi.yml new file mode 100644 index 0000000000..ddd98925a7 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-pagination/openapi.yml @@ -0,0 +1,78 @@ +openapi: 3.0.3 +info: + title: Test extension `x-fern-pagination` + version: 1.0.0 +paths: + /list: + get: + x-fern-pagination: + offset: $request.pageNumber + results: $response.users + operationId: list + summary: List + description: "" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UsersResponse" + parameters: + - in: query + name: pageNumber + schema: + type: integer + /list-with-step: + get: + x-fern-pagination: + offset: $request.pageNumber + results: $response.users + step: $request.limit + has-next-page: $response.meta.hasMore + operationId: list + summary: List + description: "" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/UsersResponse" + parameters: + - in: query + name: pageNumber + schema: + type: integer + - in: query + name: limit + schema: + type: integer +components: + schemas: + Meta: + properties: + hasMore: + type: boolean + UsersResponse: + type: object + properties: + meta: + $ref: "#/components/schemas/Meta" + users: + type: array + items: + $ref: "#/components/schemas/User" + User: + type: object + properties: + id: + type: string + format: uuid + name: + type: string + email: + type: string + age: + type: integer \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-parameter-name/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-parameter-name/openapi.yml new file mode 100644 index 0000000000..e2a8a337da --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-parameter-name/openapi.yml @@ -0,0 +1,34 @@ +openapi: 3.1.0 +info: + title: Test extension `x-fern-parameter-name` for parameters. + version: 1.0.0 +paths: + "/user/{userId}": + get: + operationId: get_user + parameters: + - in: header + name: X-API-Version + x-fern-parameter-name: version + schema: + type: string + required: true + - in: query + name: foo + x-fern-parameter-name: bar + schema: + type: string + required: true + - in: path + name: userId + x-fern-parameter-name: id + schema: + type: string + required: true + responses: + "200": + description: "Success!" + content: + application/json: + schema: + type: string \ No newline at end of file diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-property-name/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-property-name/openapi.yml new file mode 100644 index 0000000000..c582d34300 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-property-name/openapi.yml @@ -0,0 +1,14 @@ +openapi: 3.0.3 +info: + title: Test extension `x-fern-property-name` + version: 1.0.0 +paths: {} +components: + schemas: + BaseUser: + type: object + properties: + id: + x-fern-property-name: renamed_id + type: string + format: uuid diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-resolutions/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-resolutions/openapi.yml new file mode 100644 index 0000000000..f087da2d5e --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-resolutions/openapi.yml @@ -0,0 +1,43 @@ +openapi: 3.0.3 +info: + title: Test extension `x-fern-sdk-group-name` for schemas + version: 1.0.0 +paths: + /user: + get: + x-fern-sdk-group-name: ["user"] + x-fern-sdk-method-name: ["get"] + responses: + "200": + description: "Success" + content: + application/json: + schema: + type: object + properties: + id: + type: string + format: uuid + /users: + get: + x-fern-sdk-group-name: ["user"] + x-fern-sdk-method-name: ["get_all"] + responses: + "200": + description: "Success" + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + +x-fern-resolutions: + - name: User + resolutions: + - '#/paths/~1user/get/responses/200/content/application~1json/schema' + - '#/paths/~1users/get/responses/200/content/application~1json/schema/items' diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-sdk-group-name-with-streaming/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-sdk-group-name-with-streaming/openapi.yml new file mode 100644 index 0000000000..2ad35e3971 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-sdk-group-name-with-streaming/openapi.yml @@ -0,0 +1,57 @@ +openapi: 3.1.0 +info: + title: Test extension `x-fern-sdk-group-name` alongside `x-fern-streaming`. + version: 1.0.0 +paths: + "/user/{userId}": + post: + x-fern-sdk-group-name: user + x-fern-sdk-method-name: get + x-fern-streaming: + stream-condition: $request.stream + response: + $ref: "#/components/schemas/User" + response-stream: + $ref: "#/components/schemas/StreamUser" + operationId: get + parameters: + - in: path + name: userId + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + type: object + properties: + stream: + type: boolean + responses: + "200": + description: "Success!" + content: + application/json: + schema: + type: string +components: + schemas: + User: + type: object + properties: + id: + type: string + format: uuid + streamed: + x-fern-type: literal + type: boolean + StreamUser: + type: object + properties: + id: + type: string + format: uuid + streamed: + x-fern-type: literal + type: boolean diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-sdk-group-name/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-sdk-group-name/openapi.yml new file mode 100644 index 0000000000..ad7cc9b0e2 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-sdk-group-name/openapi.yml @@ -0,0 +1,46 @@ +openapi: 3.0.3 +info: + title: Test extension `x-fern-sdk-group-name` for schemas + version: 1.0.0 +paths: + /auth/user: + get: + description: This endpoint should be in `auth/user.yml` + x-fern-sdk-group-name: ["auth", "user"] + x-fern-sdk-method-name: ["get"] + responses: + "200": + description: "Success" + content: + application/json: + schema: + $ref: "#/components/schemas/User" + +components: + schemas: + UserId: + # Test nested group names + x-fern-sdk-group-name: ["ids", "user"] + type: string + PersonId: + # Test nested group names + x-fern-sdk-group-name: ["ids", "person"] + type: string + User: + description: This user object should be in user.yml + x-fern-sdk-group-name: user + type: object + properties: + id: + type: string + format: uuid + associatedPersons: + type: array + items: + $ref: '#/components/schemas/Person' + Person: + type: object + properties: + id: + type: string + format: uuid diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-audiences/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-audiences/openapi.yml new file mode 100644 index 0000000000..11e1b0df21 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-audiences/openapi.yml @@ -0,0 +1,58 @@ +openapi: 3.1.0 +info: + title: Test extension `x-fern-audiences` alongside `x-fern-streaming`. + version: 1.0.0 +paths: + "/user/{userId}": + get: + x-fern-sdk-group-name: user + x-fern-sdk-method-name: get + x-fern-streaming: + stream-condition: $request.stream + response: + $ref: "#/components/schemas/User" + response-stream: + $ref: "#/components/schemas/StreamUser" + operationId: get + parameters: + - in: path + name: userId + schema: + type: string + required: true + requestBody: + content: + application/json: + schema: + type: object + properties: + stream: + type: boolean + x-fern-audiences: [ "public" ] + responses: + "200": + description: "Success!" + content: + application/json: + schema: + type: string +components: + schemas: + User: + type: object + properties: + id: + type: string + format: uuid + streamed: + x-fern-type: literal + type: boolean + StreamUser: + type: object + properties: + id: + type: string + format: uuid + streamed: + x-fern-type: literal + type: boolean diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-reference/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-reference/openapi.yml new file mode 100644 index 0000000000..e759f3b814 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-reference/openapi.yml @@ -0,0 +1,48 @@ +openapi: 3.1.0 +info: + title: Test extension `x-fern-audiences` alongside `x-fern-streaming`. + version: 1.0.0 +paths: + "/completions/chat": + post: + x-fern-sdk-group-name: chatCompletions + x-fern-sdk-method-name: create + x-fern-streaming: + stream-condition: $request.stream + response: + $ref: "#/components/schemas/Completion" + response-stream: + $ref: "#/components/schemas/CompletionChunk" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CreateCompletionRequest" + responses: + "200": + description: "Success!" + content: + application/json: + schema: + type: string +components: + schemas: + CreateCompletionRequest: + type: object + properties: + stream: + type: boolean + prompt: + type: string + required: + - prompt + Completion: + type: object + properties: + text: + type: string + CompletionChunk: + type: object + properties: + text: + type: string diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-sse/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-sse/openapi.yml new file mode 100644 index 0000000000..f3b49eca75 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-sse/openapi.yml @@ -0,0 +1,49 @@ +openapi: 3.1.0 +info: + title: Test extension `x-fern-audiences` alongside `x-fern-streaming`. + version: 1.0.0 +paths: + "/completions/chat": + post: + x-fern-sdk-group-name: chatCompletions + x-fern-sdk-method-name: create + x-fern-streaming: + format: sse + # stream-condition: $request.stream + # response: + # $ref: "#/components/schemas/Completion" + # response-stream: + # $ref: "#/components/schemas/CompletionChunk" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CreateCompletionRequest" + responses: + "200": + description: "Success!" + content: + application/json: + schema: + type: string +components: + schemas: + CreateCompletionRequest: + type: object + properties: + stream: + type: boolean + prompt: + type: string + required: + - prompt + Completion: + type: object + properties: + text: + type: string + CompletionChunk: + type: object + properties: + text: + type: string diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-stream-condition/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-stream-condition/openapi.yml new file mode 100644 index 0000000000..234ad8e03d --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-streaming-with-stream-condition/openapi.yml @@ -0,0 +1,92 @@ +openapi: 3.1.0 +info: + version: 0.1.0 + title: Vectara REST API v2 +servers: + - url: https://api.streamingtest.io +paths: + /v2/chats: + post: + tags: + - Chats + summary: Start a chat + description: Create a chat while specifying the default retrieval parameters used by the prompt. + operationId: createChat + x-fern-streaming: + stream-condition: $request.stream_response + response: + $ref: "#/components/schemas/ChatFullResponse" + response-stream: + $ref: "#/components/schemas/ChatStreamedResponse" + x-fern-sdk-method-name: chat + parameters: + - $ref: "#/components/parameters/RequestTimeout" + - $ref: "#/components/parameters/RequestTimeoutMillis" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ChatRequest" + x-stream-based-on-body: "streamResponse()" + responses: + "200": + description: A response to a chat request. + content: + application/json: + schema: + $ref: "#/components/schemas/ChatFullResponse" + text/event-stream: + schema: + $ref: "#/components/schemas/ChatStreamedResponse" +components: + schemas: + ChatRequest: + type: object + properties: + query: + description: The chat message or question. + type: string + example: How can I use the Vectara platform? + stream_response: + description: Indicates whether the response should be streamed or not. + type: boolean + default: false + required: + - query + ChatFullResponse: + description: Full response to a chat question when the result is not streamed. + type: object + properties: + chat_id: + description: If the chat response was stored, the ID of the chat. + type: string + turn_id: + description: If the chat response was stored, the ID of the turn. + type: string + answer: + description: The message from the chat model for the chat message. + type: string + ChatStreamedResponse: + description: An individual event when the response is streamed. + type: object + properties: + chunk: + description: The chunk of the response. + type: string + example: "Hello, how can I help you today?" + parameters: + RequestTimeout: + in: header + name: Request-Timeout + description: The API will make a best effort to complete the request in the specified seconds or time out. + schema: + type: integer + minimum: 1 + required: false + RequestTimeoutMillis: + in: header + name: Request-Timeout-Millis + description: The API will make a best effort to complete the request in the specified milliseconds or time out. + schema: + type: integer + minimum: 1 diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-token-variable-name/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-token-variable-name/openapi.yml new file mode 100644 index 0000000000..076e786db8 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-token-variable-name/openapi.yml @@ -0,0 +1,54 @@ +openapi: 3.1.0 +info: + title: Test extension `x-fern-token-variable-name`. + version: 1.0.0 +paths: + "/completions/chat": + post: + x-fern-sdk-group-name: chatCompletions + x-fern-sdk-method-name: create + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CreateCompletionRequest" + responses: + "200": + description: "Success!" + content: + application/json: + schema: + type: string +components: + securitySchemes: + api_key: + type: http + scheme: bearer + x-fern-token-variable-name: apiKey + custom_header: + type: apiKey + in: header + name: X-API-Key + access_token: + type: http + scheme: bearer + schemas: + CreateCompletionRequest: + type: object + properties: + stream: + type: boolean + prompt: + type: string + required: + - prompt + Completion: + type: object + properties: + text: + type: string + CompletionChunk: + type: object + properties: + text: + type: string diff --git a/packages/parsers/src/openapi/__test__/fixtures/x-fern-version/openapi.yml b/packages/parsers/src/openapi/__test__/fixtures/x-fern-version/openapi.yml new file mode 100644 index 0000000000..dfa944c9a6 --- /dev/null +++ b/packages/parsers/src/openapi/__test__/fixtures/x-fern-version/openapi.yml @@ -0,0 +1,60 @@ +openapi: 3.1.0 +info: + title: Test extension `x-fern-version`. + version: 1.0.0 +x-fern-version: + header: X-API-Version + default: "2.0.0" + values: + - "1.0.0" + - "2.0.0" + - "Latest" +paths: + "/completions/chat": + post: + x-fern-sdk-group-name: chatCompletions + x-fern-sdk-method-name: create + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CreateCompletionRequest" + responses: + "200": + description: "Success!" + content: + application/json: + schema: + type: string +components: + securitySchemes: + api_key: + type: http + scheme: bearer + custom_header: + type: apiKey + in: header + name: X-API-Key + access_token: + type: http + scheme: bearer + schemas: + CreateCompletionRequest: + type: object + properties: + stream: + type: boolean + prompt: + type: string + required: + - prompt + Completion: + type: object + properties: + text: + type: string + CompletionChunk: + type: object + properties: + text: + type: string diff --git a/packages/parsers/src/openapi/utils/__test__/3.1/convertToObjectProperties.test.ts b/packages/parsers/src/openapi/utils/__test__/3.1/convertToObjectProperties.test.ts index 2bf71114f0..771ffce177 100644 --- a/packages/parsers/src/openapi/utils/__test__/3.1/convertToObjectProperties.test.ts +++ b/packages/parsers/src/openapi/utils/__test__/3.1/convertToObjectProperties.test.ts @@ -36,6 +36,7 @@ describe("convertToObjectProperties", () => { context: mockContext, accessPath: [], pathId: "", + seenSchemas: new Set(), }); nameSchemaConverterNode.availability = new AvailabilityConverterNode({ input: { @@ -55,6 +56,7 @@ describe("convertToObjectProperties", () => { context: mockContext, accessPath: [], pathId: "", + seenSchemas: new Set(), }), }; @@ -100,6 +102,7 @@ describe("convertToObjectProperties", () => { context: mockContext, accessPath: [], pathId: "", + seenSchemas: new Set(), }); const properties = { diff --git a/packages/parsers/src/openrpc/1.x/MethodConverter.node.ts b/packages/parsers/src/openrpc/1.x/MethodConverter.node.ts index bc766f793b..30756a9519 100644 --- a/packages/parsers/src/openrpc/1.x/MethodConverter.node.ts +++ b/packages/parsers/src/openrpc/1.x/MethodConverter.node.ts @@ -51,6 +51,7 @@ export class MethodConverterNode extends BaseOpenrpcConverterNode< context: this.context, accessPath: this.accessPath, pathId: "result", + seenSchemas: new Set(), }).convert() : undefined; @@ -69,6 +70,7 @@ export class MethodConverterNode extends BaseOpenrpcConverterNode< context: this.context, accessPath: this.accessPath, pathId: `params/${param.name}`, + seenSchemas: new Set(), }).convert(); if (!schema) return undefined;