intercom-client 6.0.0 → 6.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -30
- package/api/resources/admins/client/Client.js +10 -10
- package/api/resources/admins/types/Admin.d.ts +11 -2
- package/api/resources/articles/client/Client.js +12 -12
- package/api/resources/articles/client/requests/CreateArticleRequest.d.ts +9 -1
- package/api/resources/articles/client/requests/CreateArticleRequest.js +4 -0
- package/api/resources/articles/client/requests/UpdateArticleRequest.d.ts +9 -1
- package/api/resources/articles/client/requests/UpdateArticleRequest.js +4 -0
- package/api/resources/companies/client/Client.d.ts +2 -2
- package/api/resources/companies/client/Client.js +24 -24
- package/api/resources/companies/client/requests/CreateOrUpdateCompanyRequest.d.ts +1 -1
- package/api/resources/companies/types/Company.d.ts +1 -1
- package/api/resources/contacts/client/Client.d.ts +1 -2
- package/api/resources/contacts/client/Client.js +31 -32
- package/api/resources/contacts/types/Contact.d.ts +4 -11
- package/api/resources/conversations/client/Client.d.ts +28 -14
- package/api/resources/conversations/client/Client.js +52 -38
- package/api/resources/conversations/client/requests/CreateConversationRequest.d.ts +2 -0
- package/api/resources/conversations/client/requests/ManageConversationPartsRequest.d.ts +10 -20
- package/api/resources/dataAttributes/client/Client.js +6 -6
- package/api/resources/dataExport/client/Client.js +8 -8
- package/api/resources/events/client/Client.d.ts +0 -2
- package/api/resources/events/client/Client.js +6 -8
- package/api/resources/helpCenters/client/Client.js +4 -4
- package/api/resources/helpCenters/resources/collections/client/Client.js +10 -10
- package/api/resources/index.d.ts +0 -2
- package/api/resources/index.js +1 -3
- package/api/resources/messages/client/Client.d.ts +3 -23
- package/api/resources/messages/client/Client.js +5 -25
- package/api/resources/news/resources/feeds/client/Client.js +6 -6
- package/api/resources/news/resources/items/client/Client.js +10 -10
- package/api/resources/notes/client/Client.js +6 -6
- package/api/resources/phoneCallRedirects/client/Client.js +2 -2
- package/api/resources/segments/client/Client.js +4 -4
- package/api/resources/subscriptionTypes/client/Client.js +2 -2
- package/api/resources/subscriptionTypes/types/SubscriptionType.d.ts +1 -1
- package/api/resources/tags/client/Client.d.ts +0 -1
- package/api/resources/tags/client/Client.js +20 -21
- package/api/resources/tags/types/Tag.d.ts +1 -1
- package/api/resources/teams/client/Client.js +4 -4
- package/api/resources/ticketTypes/client/Client.js +8 -8
- package/api/resources/ticketTypes/resources/attributes/client/Client.js +4 -4
- package/api/resources/tickets/client/Client.js +10 -10
- package/api/resources/visitors/client/Client.js +6 -6
- package/api/types/ActionComponent.d.ts +16 -0
- package/api/types/ArticleList.d.ts +1 -1
- package/api/types/ButtonComponent.d.ts +33 -0
- package/api/types/ButtonComponent.js +14 -0
- package/api/types/CanvasObject.d.ts +20 -0
- package/api/types/CheckboxComponent.d.ts +36 -0
- package/api/types/CheckboxComponent.js +14 -0
- package/api/types/CheckboxOption.d.ts +16 -0
- package/api/types/CheckboxOption.js +5 -0
- package/api/types/CollectionList.d.ts +1 -1
- package/api/types/CompanyList.d.ts +1 -1
- package/api/types/Component.d.ts +43 -0
- package/api/types/Component.js +5 -0
- package/api/types/ConfigureRequest.d.ts +22 -0
- package/api/types/ConfigureRequest.js +5 -0
- package/api/types/ConfigureResponse.d.ts +12 -0
- package/api/types/ConfigureResponse.js +5 -0
- package/api/types/ContactCompanies.d.ts +5 -0
- package/api/types/ContactCompany.d.ts +14 -0
- package/api/types/ContactCompany.js +5 -0
- package/api/types/ContentObject.d.ts +13 -0
- package/api/types/ContentObject.js +5 -0
- package/api/types/Context.d.ts +34 -0
- package/api/types/Context.js +15 -0
- package/api/types/ConversationSource.d.ts +19 -1
- package/api/types/ConversationSource.js +16 -0
- package/api/types/ConversationTeammates.d.ts +2 -2
- package/api/types/CurrentCanvas.d.ts +11 -0
- package/api/types/CurrentCanvas.js +5 -0
- package/api/types/CustomAttributes.d.ts +2 -6
- package/api/types/DataEventSummaryItem.d.ts +1 -1
- package/api/types/DataTableComponent.d.ts +11 -0
- package/api/types/DataTableComponent.js +5 -0
- package/api/types/DataTableItem.d.ts +14 -0
- package/api/types/DataTableItem.js +5 -0
- package/api/types/DividerComponent.d.ts +12 -0
- package/api/types/DividerComponent.js +5 -0
- package/api/types/DropdownComponent.d.ts +34 -0
- package/api/types/DropdownComponent.js +14 -0
- package/api/types/DropdownOption.d.ts +16 -0
- package/api/types/DropdownOption.js +5 -0
- package/api/types/Error_.d.ts +1 -1
- package/api/types/Event.d.ts +10 -0
- package/api/types/Event.js +5 -0
- package/api/types/ImageComponent.d.ts +40 -0
- package/api/types/ImageComponent.js +15 -0
- package/api/types/InitializeRequest.d.ts +23 -0
- package/api/types/InitializeRequest.js +5 -0
- package/api/types/InitializeResponse.d.ts +11 -0
- package/api/types/InitializeResponse.js +5 -0
- package/api/types/InputComponent.d.ts +37 -0
- package/api/types/InputComponent.js +14 -0
- package/api/types/ListComponent.d.ts +23 -0
- package/api/types/ListComponent.js +5 -0
- package/api/types/ListItem.d.ts +25 -0
- package/api/types/ListItem.js +5 -0
- package/api/types/ListItemWithImage.d.ts +12 -0
- package/api/types/ListItemWithImage.js +5 -0
- package/api/types/ListItemWithoutImage.d.ts +12 -0
- package/api/types/ListItemWithoutImage.js +5 -0
- package/api/types/LiveCanvasRequest.d.ts +21 -0
- package/api/types/LiveCanvasRequest.js +5 -0
- package/api/types/LiveCanvasResponse.d.ts +11 -0
- package/api/types/LiveCanvasResponse.js +5 -0
- package/api/types/MultipleFilterSearchRequest.d.ts +1 -8
- package/api/types/MultipleOrSingleFilterSearchRequest.d.ts +5 -0
- package/api/types/MultipleOrSingleFilterSearchRequest.js +5 -0
- package/api/types/NoteList.d.ts +1 -1
- package/api/types/OffsetPages.d.ts +14 -0
- package/api/types/OffsetPages.js +5 -0
- package/api/types/ResultsResponse.d.ts +10 -0
- package/api/types/ResultsResponse.js +5 -0
- package/api/types/SheetActionComponent.d.ts +12 -0
- package/api/types/SheetActionComponent.js +5 -0
- package/api/types/SingleFilterSearchRequest.d.ts +5 -1
- package/api/types/SingleSelectComponent.d.ts +39 -0
- package/api/types/SingleSelectComponent.js +14 -0
- package/api/types/SingleSelectOption.d.ts +16 -0
- package/api/types/SingleSelectOption.js +5 -0
- package/api/types/SocialProfile.d.ts +1 -1
- package/api/types/SpacerComponent.d.ts +25 -0
- package/api/types/SpacerComponent.js +16 -0
- package/api/types/SubmitActionComponent.d.ts +8 -0
- package/api/types/SubmitActionComponent.js +5 -0
- package/api/types/SubmitRequest.d.ts +29 -0
- package/api/types/SubmitRequest.js +5 -0
- package/api/types/SubmitResponse.d.ts +23 -0
- package/api/types/SubmitResponse.js +5 -0
- package/api/types/TextAreaComponent.d.ts +22 -0
- package/api/types/TextAreaComponent.js +5 -0
- package/api/types/TextComponent.d.ts +39 -0
- package/api/types/TextComponent.js +20 -0
- package/api/types/TicketTypeAttribute.d.ts +16 -1
- package/api/types/TicketTypeAttribute.js +13 -0
- package/api/types/UrlActionComponent.d.ts +10 -0
- package/api/types/UrlActionComponent.js +5 -0
- package/api/types/Visitor.d.ts +2 -2
- package/api/types/index.d.ts +42 -1
- package/api/types/index.js +42 -1
- package/dist/api/resources/admins/client/Client.js +10 -10
- package/dist/api/resources/admins/types/Admin.d.ts +11 -2
- package/dist/api/resources/articles/client/Client.js +12 -12
- package/dist/api/resources/articles/client/requests/CreateArticleRequest.d.ts +9 -1
- package/dist/api/resources/articles/client/requests/CreateArticleRequest.js +4 -0
- package/dist/api/resources/articles/client/requests/UpdateArticleRequest.d.ts +9 -1
- package/dist/api/resources/articles/client/requests/UpdateArticleRequest.js +4 -0
- package/dist/api/resources/companies/client/Client.d.ts +2 -2
- package/dist/api/resources/companies/client/Client.js +24 -24
- package/dist/api/resources/companies/client/requests/CreateOrUpdateCompanyRequest.d.ts +1 -1
- package/dist/api/resources/companies/types/Company.d.ts +1 -1
- package/dist/api/resources/contacts/client/Client.d.ts +1 -2
- package/dist/api/resources/contacts/client/Client.js +31 -32
- package/dist/api/resources/contacts/types/Contact.d.ts +4 -11
- package/dist/api/resources/conversations/client/Client.d.ts +28 -14
- package/dist/api/resources/conversations/client/Client.js +52 -38
- package/dist/api/resources/conversations/client/requests/CreateConversationRequest.d.ts +2 -0
- package/dist/api/resources/conversations/client/requests/ManageConversationPartsRequest.d.ts +10 -20
- package/dist/api/resources/dataAttributes/client/Client.js +6 -6
- package/dist/api/resources/dataExport/client/Client.js +8 -8
- package/dist/api/resources/events/client/Client.d.ts +0 -2
- package/dist/api/resources/events/client/Client.js +6 -8
- package/dist/api/resources/helpCenters/client/Client.js +4 -4
- package/dist/api/resources/helpCenters/resources/collections/client/Client.js +10 -10
- package/dist/api/resources/index.d.ts +0 -2
- package/dist/api/resources/index.js +1 -3
- package/dist/api/resources/messages/client/Client.d.ts +3 -23
- package/dist/api/resources/messages/client/Client.js +5 -25
- package/dist/api/resources/news/resources/feeds/client/Client.js +6 -6
- package/dist/api/resources/news/resources/items/client/Client.js +10 -10
- package/dist/api/resources/notes/client/Client.js +6 -6
- package/dist/api/resources/phoneCallRedirects/client/Client.js +2 -2
- package/dist/api/resources/segments/client/Client.js +4 -4
- package/dist/api/resources/subscriptionTypes/client/Client.js +2 -2
- package/dist/api/resources/subscriptionTypes/types/SubscriptionType.d.ts +1 -1
- package/dist/api/resources/tags/client/Client.d.ts +0 -1
- package/dist/api/resources/tags/client/Client.js +20 -21
- package/dist/api/resources/tags/types/Tag.d.ts +1 -1
- package/dist/api/resources/teams/client/Client.js +4 -4
- package/dist/api/resources/ticketTypes/client/Client.js +8 -8
- package/dist/api/resources/ticketTypes/resources/attributes/client/Client.js +4 -4
- package/dist/api/resources/tickets/client/Client.js +10 -10
- package/dist/api/resources/visitors/client/Client.js +6 -6
- package/dist/api/types/ActionComponent.d.ts +16 -0
- package/dist/api/types/ActionComponent.js +5 -0
- package/dist/api/types/ArticleList.d.ts +1 -1
- package/dist/api/types/ButtonComponent.d.ts +33 -0
- package/dist/api/types/ButtonComponent.js +14 -0
- package/dist/api/types/CanvasObject.d.ts +20 -0
- package/dist/api/types/CanvasObject.js +5 -0
- package/dist/api/types/CheckboxComponent.d.ts +36 -0
- package/dist/api/types/CheckboxComponent.js +14 -0
- package/dist/api/types/CheckboxOption.d.ts +16 -0
- package/dist/api/types/CheckboxOption.js +5 -0
- package/dist/api/types/CollectionList.d.ts +1 -1
- package/dist/api/types/CompanyList.d.ts +1 -1
- package/dist/api/types/Component.d.ts +43 -0
- package/dist/api/types/Component.js +5 -0
- package/dist/api/types/ConfigureRequest.d.ts +22 -0
- package/dist/api/types/ConfigureRequest.js +5 -0
- package/dist/api/types/ConfigureResponse.d.ts +12 -0
- package/dist/api/types/ConfigureResponse.js +5 -0
- package/dist/api/types/ContactCompanies.d.ts +5 -0
- package/dist/api/types/ContactCompany.d.ts +14 -0
- package/dist/api/types/ContactCompany.js +5 -0
- package/dist/api/types/ContentObject.d.ts +13 -0
- package/dist/api/types/ContentObject.js +5 -0
- package/dist/api/types/Context.d.ts +34 -0
- package/dist/api/types/Context.js +15 -0
- package/dist/api/types/ConversationSource.d.ts +19 -1
- package/dist/api/types/ConversationSource.js +16 -0
- package/dist/api/types/ConversationTeammates.d.ts +2 -2
- package/dist/api/types/CurrentCanvas.d.ts +11 -0
- package/dist/api/types/CurrentCanvas.js +5 -0
- package/dist/api/types/CustomAttributes.d.ts +2 -6
- package/dist/api/types/DataEventSummaryItem.d.ts +1 -1
- package/dist/api/types/DataTableComponent.d.ts +11 -0
- package/dist/api/types/DataTableComponent.js +5 -0
- package/dist/api/types/DataTableItem.d.ts +14 -0
- package/dist/api/types/DataTableItem.js +5 -0
- package/dist/api/types/DividerComponent.d.ts +12 -0
- package/dist/api/types/DividerComponent.js +5 -0
- package/dist/api/types/DropdownComponent.d.ts +34 -0
- package/dist/api/types/DropdownComponent.js +14 -0
- package/dist/api/types/DropdownOption.d.ts +16 -0
- package/dist/api/types/DropdownOption.js +5 -0
- package/dist/api/types/Error_.d.ts +1 -1
- package/dist/api/types/Event.d.ts +10 -0
- package/dist/api/types/Event.js +5 -0
- package/dist/api/types/ImageComponent.d.ts +40 -0
- package/dist/api/types/ImageComponent.js +15 -0
- package/dist/api/types/InitializeRequest.d.ts +23 -0
- package/dist/api/types/InitializeRequest.js +5 -0
- package/dist/api/types/InitializeResponse.d.ts +11 -0
- package/dist/api/types/InitializeResponse.js +5 -0
- package/dist/api/types/InputComponent.d.ts +37 -0
- package/dist/api/types/InputComponent.js +14 -0
- package/dist/api/types/ListComponent.d.ts +23 -0
- package/dist/api/types/ListComponent.js +5 -0
- package/dist/api/types/ListItem.d.ts +25 -0
- package/dist/api/types/ListItem.js +5 -0
- package/dist/api/types/ListItemWithImage.d.ts +12 -0
- package/dist/api/types/ListItemWithImage.js +5 -0
- package/dist/api/types/ListItemWithoutImage.d.ts +12 -0
- package/dist/api/types/ListItemWithoutImage.js +5 -0
- package/dist/api/types/LiveCanvasRequest.d.ts +21 -0
- package/dist/api/types/LiveCanvasRequest.js +5 -0
- package/dist/api/types/LiveCanvasResponse.d.ts +11 -0
- package/dist/api/types/LiveCanvasResponse.js +5 -0
- package/dist/api/types/MultipleFilterSearchRequest.d.ts +1 -8
- package/dist/api/types/MultipleOrSingleFilterSearchRequest.d.ts +5 -0
- package/dist/api/types/MultipleOrSingleFilterSearchRequest.js +5 -0
- package/dist/api/types/NoteList.d.ts +1 -1
- package/dist/api/types/OffsetPages.d.ts +14 -0
- package/dist/api/types/OffsetPages.js +5 -0
- package/dist/api/types/ResultsResponse.d.ts +10 -0
- package/dist/api/types/ResultsResponse.js +5 -0
- package/dist/api/types/SheetActionComponent.d.ts +12 -0
- package/dist/api/types/SheetActionComponent.js +5 -0
- package/dist/api/types/SingleFilterSearchRequest.d.ts +5 -1
- package/dist/api/types/SingleSelectComponent.d.ts +39 -0
- package/dist/api/types/SingleSelectComponent.js +14 -0
- package/dist/api/types/SingleSelectOption.d.ts +16 -0
- package/dist/api/types/SingleSelectOption.js +5 -0
- package/dist/api/types/SocialProfile.d.ts +1 -1
- package/dist/api/types/SpacerComponent.d.ts +25 -0
- package/dist/api/types/SpacerComponent.js +16 -0
- package/dist/api/types/SubmitActionComponent.d.ts +8 -0
- package/dist/api/types/SubmitActionComponent.js +5 -0
- package/dist/api/types/SubmitRequest.d.ts +29 -0
- package/dist/api/types/SubmitRequest.js +5 -0
- package/dist/api/types/SubmitResponse.d.ts +23 -0
- package/dist/api/types/SubmitResponse.js +5 -0
- package/dist/api/types/TextAreaComponent.d.ts +22 -0
- package/dist/api/types/TextAreaComponent.js +5 -0
- package/dist/api/types/TextComponent.d.ts +39 -0
- package/dist/api/types/TextComponent.js +20 -0
- package/dist/api/types/TicketTypeAttribute.d.ts +16 -1
- package/dist/api/types/TicketTypeAttribute.js +13 -0
- package/dist/api/types/UrlActionComponent.d.ts +10 -0
- package/dist/api/types/UrlActionComponent.js +5 -0
- package/dist/api/types/Visitor.d.ts +2 -2
- package/dist/api/types/index.d.ts +42 -1
- package/dist/api/types/index.js +42 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +10 -2
- package/reference.md +12 -15
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/customObjectInstances/index.d.ts +0 -1
- package/api/resources/customObjectInstances/index.js +0 -17
- package/api/resources/customObjectInstances/types/CustomObjectInstance.d.ts +0 -16
- package/api/resources/customObjectInstances/types/index.d.ts +0 -1
- package/api/resources/customObjectInstances/types/index.js +0 -17
- package/dist/api/resources/customObjectInstances/index.d.ts +0 -1
- package/dist/api/resources/customObjectInstances/index.js +0 -17
- package/dist/api/resources/customObjectInstances/types/CustomObjectInstance.d.ts +0 -16
- package/dist/api/resources/customObjectInstances/types/index.d.ts +0 -1
- package/dist/api/resources/customObjectInstances/types/index.js +0 -17
- /package/api/{resources/customObjectInstances/types/CustomObjectInstance.js → types/ActionComponent.js} +0 -0
- /package/{dist/api/resources/customObjectInstances/types/CustomObjectInstance.js → api/types/CanvasObject.js} +0 -0
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* A text component is used for rendering blocks of text. Links and bold font can be rendered through Markdown. There are different styles provided which edit the color, weight, and font size. These cannot be edited through Markdown.
|
|
6
|
+
*/
|
|
7
|
+
export interface TextComponent {
|
|
8
|
+
/** A unique identifier for the component. */
|
|
9
|
+
id?: string;
|
|
10
|
+
/** The text that will be rendered. */
|
|
11
|
+
text: string;
|
|
12
|
+
/** Aligns the text. Default is `left`. */
|
|
13
|
+
align?: TextComponent.Align;
|
|
14
|
+
/** Styles the text. Default is `paragraph`. */
|
|
15
|
+
style?: TextComponent.Style;
|
|
16
|
+
/** Disables a component's margin-bottom of 10px. */
|
|
17
|
+
bottom_margin?: "none";
|
|
18
|
+
}
|
|
19
|
+
export declare namespace TextComponent {
|
|
20
|
+
/**
|
|
21
|
+
* Aligns the text. Default is `left`.
|
|
22
|
+
*/
|
|
23
|
+
type Align = "left" | "center" | "right";
|
|
24
|
+
const Align: {
|
|
25
|
+
readonly Left: "left";
|
|
26
|
+
readonly Center: "center";
|
|
27
|
+
readonly Right: "right";
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Styles the text. Default is `paragraph`.
|
|
31
|
+
*/
|
|
32
|
+
type Style = "header" | "paragraph" | "muted" | "error";
|
|
33
|
+
const Style: {
|
|
34
|
+
readonly Header: "header";
|
|
35
|
+
readonly Paragraph: "paragraph";
|
|
36
|
+
readonly Muted: "muted";
|
|
37
|
+
readonly Error: "error";
|
|
38
|
+
};
|
|
39
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.TextComponent = void 0;
|
|
7
|
+
var TextComponent;
|
|
8
|
+
(function (TextComponent) {
|
|
9
|
+
TextComponent.Align = {
|
|
10
|
+
Left: "left",
|
|
11
|
+
Center: "center",
|
|
12
|
+
Right: "right",
|
|
13
|
+
};
|
|
14
|
+
TextComponent.Style = {
|
|
15
|
+
Header: "header",
|
|
16
|
+
Paragraph: "paragraph",
|
|
17
|
+
Muted: "muted",
|
|
18
|
+
Error: "error",
|
|
19
|
+
};
|
|
20
|
+
})(TextComponent = exports.TextComponent || (exports.TextComponent = {}));
|
|
@@ -16,7 +16,7 @@ export interface TicketTypeAttribute {
|
|
|
16
16
|
/** The description of the ticket type attribute */
|
|
17
17
|
description: string;
|
|
18
18
|
/** The type of the data attribute (allowed values: "string list integer decimal boolean datetime files") */
|
|
19
|
-
data_type:
|
|
19
|
+
data_type: TicketTypeAttribute.DataType;
|
|
20
20
|
/** Input options for the attribute */
|
|
21
21
|
input_options: Record<string, unknown>;
|
|
22
22
|
/** The order of the attribute against other attributes */
|
|
@@ -40,3 +40,18 @@ export interface TicketTypeAttribute {
|
|
|
40
40
|
/** The date and time the ticket type attribute was last updated. */
|
|
41
41
|
updated_at?: number;
|
|
42
42
|
}
|
|
43
|
+
export declare namespace TicketTypeAttribute {
|
|
44
|
+
/**
|
|
45
|
+
* The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")
|
|
46
|
+
*/
|
|
47
|
+
type DataType = "string" | "list" | "integer" | "decimal" | "boolean" | "datetime" | "files";
|
|
48
|
+
const DataType: {
|
|
49
|
+
readonly String: "string";
|
|
50
|
+
readonly List: "list";
|
|
51
|
+
readonly Integer: "integer";
|
|
52
|
+
readonly Decimal: "decimal";
|
|
53
|
+
readonly Boolean: "boolean";
|
|
54
|
+
readonly Datetime: "datetime";
|
|
55
|
+
readonly Files: "files";
|
|
56
|
+
};
|
|
57
|
+
}
|
|
@@ -3,3 +3,16 @@
|
|
|
3
3
|
* This file was auto-generated by Fern from our API Definition.
|
|
4
4
|
*/
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.TicketTypeAttribute = void 0;
|
|
7
|
+
var TicketTypeAttribute;
|
|
8
|
+
(function (TicketTypeAttribute) {
|
|
9
|
+
TicketTypeAttribute.DataType = {
|
|
10
|
+
String: "string",
|
|
11
|
+
List: "list",
|
|
12
|
+
Integer: "integer",
|
|
13
|
+
Decimal: "decimal",
|
|
14
|
+
Boolean: "boolean",
|
|
15
|
+
Datetime: "datetime",
|
|
16
|
+
Files: "files",
|
|
17
|
+
};
|
|
18
|
+
})(TicketTypeAttribute = exports.TicketTypeAttribute || (exports.TicketTypeAttribute = {}));
|
|
@@ -7,7 +7,7 @@ import * as Intercom from "../index";
|
|
|
7
7
|
*/
|
|
8
8
|
export interface Visitor {
|
|
9
9
|
/** Value is 'visitor' */
|
|
10
|
-
type:
|
|
10
|
+
type: "visitor";
|
|
11
11
|
/** The Intercom defined id representing the Visitor. */
|
|
12
12
|
id: string;
|
|
13
13
|
/** Automatically generated identifier for the Visitor. */
|
|
@@ -51,7 +51,7 @@ export interface Visitor {
|
|
|
51
51
|
tags?: Visitor.Tags;
|
|
52
52
|
segments?: Visitor.Segments;
|
|
53
53
|
/** The custom attributes you have set on the Visitor. */
|
|
54
|
-
custom_attributes?: Record<string,
|
|
54
|
+
custom_attributes?: Record<string, unknown>;
|
|
55
55
|
/** The referer of the visitor. */
|
|
56
56
|
referrer?: string;
|
|
57
57
|
/** The utm_campaign of the visitor. */
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export * from "./ActionComponent";
|
|
1
2
|
export * from "./ActivityLog";
|
|
2
3
|
export * from "./ActivityLogList";
|
|
3
4
|
export * from "./ActivityLogMetadata";
|
|
@@ -13,15 +14,23 @@ export * from "./ArticleList";
|
|
|
13
14
|
export * from "./ArticleStatistics";
|
|
14
15
|
export * from "./ArticleTranslatedContent";
|
|
15
16
|
export * from "./AssignConversationRequest";
|
|
17
|
+
export * from "./ButtonComponent";
|
|
18
|
+
export * from "./CanvasObject";
|
|
19
|
+
export * from "./CheckboxOption";
|
|
20
|
+
export * from "./CheckboxComponent";
|
|
16
21
|
export * from "./CloseConversationRequest";
|
|
17
22
|
export * from "./CollectionList";
|
|
18
23
|
export * from "./CompanyAttachedContacts";
|
|
19
24
|
export * from "./CompanyAttachedSegments";
|
|
20
25
|
export * from "./CompanyList";
|
|
21
26
|
export * from "./CompanyScroll";
|
|
27
|
+
export * from "./Component";
|
|
28
|
+
export * from "./ConfigureRequest";
|
|
29
|
+
export * from "./ConfigureResponse";
|
|
22
30
|
export * from "./ContactArchived";
|
|
23
31
|
export * from "./ContactAttachedCompanies";
|
|
24
32
|
export * from "./ContactCompanies";
|
|
33
|
+
export * from "./ContactCompany";
|
|
25
34
|
export * from "./ContactDeleted";
|
|
26
35
|
export * from "./ContactList";
|
|
27
36
|
export * from "./ContactLocation";
|
|
@@ -41,7 +50,9 @@ export * from "./ContactSocialProfiles";
|
|
|
41
50
|
export * from "./ContactSubscriptionTypes";
|
|
42
51
|
export * from "./ContactTags";
|
|
43
52
|
export * from "./ContactUnarchived";
|
|
53
|
+
export * from "./ContentObject";
|
|
44
54
|
export * from "./ContentSourcesList";
|
|
55
|
+
export * from "./Context";
|
|
45
56
|
export * from "./ConversationAttachmentFiles";
|
|
46
57
|
export * from "./ConversationContacts";
|
|
47
58
|
export * from "./ConversationFirstContactReply";
|
|
@@ -58,24 +69,41 @@ export * from "./CreateDataEventRequest";
|
|
|
58
69
|
export * from "./CreateMessageRequest";
|
|
59
70
|
export * from "./CreateOrUpdateTagRequest";
|
|
60
71
|
export * from "./CreateTicketReplyWithCommentRequest";
|
|
72
|
+
export * from "./CurrentCanvas";
|
|
61
73
|
export * from "./CursorPages";
|
|
62
|
-
export * from "./CustomAttributes";
|
|
63
74
|
export * from "./CustomerRequest";
|
|
64
75
|
export * from "./DataAttributeList";
|
|
65
76
|
export * from "./DataEventList";
|
|
66
77
|
export * from "./DataEventSummary";
|
|
67
78
|
export * from "./DataEventSummaryItem";
|
|
68
79
|
export * from "./DataExportCsv";
|
|
80
|
+
export * from "./DataTableItem";
|
|
81
|
+
export * from "./DataTableComponent";
|
|
69
82
|
export * from "./DeletedArticleObject";
|
|
70
83
|
export * from "./DeletedCollectionObject";
|
|
71
84
|
export * from "./DeletedCompanyObject";
|
|
72
85
|
export * from "./DeletedObject";
|
|
86
|
+
export * from "./DividerComponent";
|
|
87
|
+
export * from "./DropdownOption";
|
|
88
|
+
export * from "./DropdownComponent";
|
|
73
89
|
export * from "./Error_";
|
|
90
|
+
export * from "./Event";
|
|
74
91
|
export * from "./FileAttribute";
|
|
75
92
|
export * from "./GroupContent";
|
|
76
93
|
export * from "./GroupTranslatedContent";
|
|
94
|
+
export * from "./ImageComponent";
|
|
95
|
+
export * from "./InitializeRequest";
|
|
96
|
+
export * from "./InitializeResponse";
|
|
97
|
+
export * from "./InputComponent";
|
|
77
98
|
export * from "./LinkedObject";
|
|
78
99
|
export * from "./LinkedObjectList";
|
|
100
|
+
export * from "./ListItem";
|
|
101
|
+
export * from "./ListItemWithImage";
|
|
102
|
+
export * from "./ListItemWithoutImage";
|
|
103
|
+
export * from "./ListComponent";
|
|
104
|
+
export * from "./LiveCanvasRequest";
|
|
105
|
+
export * from "./LiveCanvasResponse";
|
|
106
|
+
export * from "./MultipleOrSingleFilterSearchRequest";
|
|
79
107
|
export * from "./MultipleFilterSearchRequest";
|
|
80
108
|
export * from "./NewsItemRequest";
|
|
81
109
|
export * from "./NoteList";
|
|
@@ -88,13 +116,21 @@ export * from "./PhoneSwitch";
|
|
|
88
116
|
export * from "./RedactConversationRequest";
|
|
89
117
|
export * from "./Reference";
|
|
90
118
|
export * from "./ReplyConversationRequest";
|
|
119
|
+
export * from "./ResultsResponse";
|
|
91
120
|
export * from "./SearchRequest";
|
|
92
121
|
export * from "./SegmentList";
|
|
122
|
+
export * from "./SheetActionComponent";
|
|
93
123
|
export * from "./SingleFilterSearchRequest";
|
|
124
|
+
export * from "./SingleSelectOption";
|
|
125
|
+
export * from "./SingleSelectComponent";
|
|
94
126
|
export * from "./SlaApplied";
|
|
95
127
|
export * from "./SnoozeConversationRequest";
|
|
96
128
|
export * from "./SocialProfile";
|
|
129
|
+
export * from "./SpacerComponent";
|
|
97
130
|
export * from "./StartingAfterPaging";
|
|
131
|
+
export * from "./SubmitActionComponent";
|
|
132
|
+
export * from "./SubmitRequest";
|
|
133
|
+
export * from "./SubmitResponse";
|
|
98
134
|
export * from "./SubscriptionTypeList";
|
|
99
135
|
export * from "./TagCompanyRequest";
|
|
100
136
|
export * from "./TagList";
|
|
@@ -102,6 +138,8 @@ export * from "./TagMultipleUsersRequest";
|
|
|
102
138
|
export * from "./Tags";
|
|
103
139
|
export * from "./TeamList";
|
|
104
140
|
export * from "./TeamPriorityLevel";
|
|
141
|
+
export * from "./TextComponent";
|
|
142
|
+
export * from "./TextAreaComponent";
|
|
105
143
|
export * from "./TicketCustomAttributes";
|
|
106
144
|
export * from "./TicketList";
|
|
107
145
|
export * from "./TicketPartAuthor";
|
|
@@ -114,5 +152,8 @@ export * from "./TicketTypeList";
|
|
|
114
152
|
export * from "./Translation";
|
|
115
153
|
export * from "./UntagCompanyRequest";
|
|
116
154
|
export * from "./UpdateVisitorRequest";
|
|
155
|
+
export * from "./UrlActionComponent";
|
|
117
156
|
export * from "./Visitor";
|
|
118
157
|
export * from "./VisitorDeletedObject";
|
|
158
|
+
export * from "./CustomAttributes";
|
|
159
|
+
export * from "./OffsetPages";
|
package/dist/api/types/index.js
CHANGED
|
@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./ActionComponent"), exports);
|
|
17
18
|
__exportStar(require("./ActivityLog"), exports);
|
|
18
19
|
__exportStar(require("./ActivityLogList"), exports);
|
|
19
20
|
__exportStar(require("./ActivityLogMetadata"), exports);
|
|
@@ -29,15 +30,23 @@ __exportStar(require("./ArticleList"), exports);
|
|
|
29
30
|
__exportStar(require("./ArticleStatistics"), exports);
|
|
30
31
|
__exportStar(require("./ArticleTranslatedContent"), exports);
|
|
31
32
|
__exportStar(require("./AssignConversationRequest"), exports);
|
|
33
|
+
__exportStar(require("./ButtonComponent"), exports);
|
|
34
|
+
__exportStar(require("./CanvasObject"), exports);
|
|
35
|
+
__exportStar(require("./CheckboxOption"), exports);
|
|
36
|
+
__exportStar(require("./CheckboxComponent"), exports);
|
|
32
37
|
__exportStar(require("./CloseConversationRequest"), exports);
|
|
33
38
|
__exportStar(require("./CollectionList"), exports);
|
|
34
39
|
__exportStar(require("./CompanyAttachedContacts"), exports);
|
|
35
40
|
__exportStar(require("./CompanyAttachedSegments"), exports);
|
|
36
41
|
__exportStar(require("./CompanyList"), exports);
|
|
37
42
|
__exportStar(require("./CompanyScroll"), exports);
|
|
43
|
+
__exportStar(require("./Component"), exports);
|
|
44
|
+
__exportStar(require("./ConfigureRequest"), exports);
|
|
45
|
+
__exportStar(require("./ConfigureResponse"), exports);
|
|
38
46
|
__exportStar(require("./ContactArchived"), exports);
|
|
39
47
|
__exportStar(require("./ContactAttachedCompanies"), exports);
|
|
40
48
|
__exportStar(require("./ContactCompanies"), exports);
|
|
49
|
+
__exportStar(require("./ContactCompany"), exports);
|
|
41
50
|
__exportStar(require("./ContactDeleted"), exports);
|
|
42
51
|
__exportStar(require("./ContactList"), exports);
|
|
43
52
|
__exportStar(require("./ContactLocation"), exports);
|
|
@@ -57,7 +66,9 @@ __exportStar(require("./ContactSocialProfiles"), exports);
|
|
|
57
66
|
__exportStar(require("./ContactSubscriptionTypes"), exports);
|
|
58
67
|
__exportStar(require("./ContactTags"), exports);
|
|
59
68
|
__exportStar(require("./ContactUnarchived"), exports);
|
|
69
|
+
__exportStar(require("./ContentObject"), exports);
|
|
60
70
|
__exportStar(require("./ContentSourcesList"), exports);
|
|
71
|
+
__exportStar(require("./Context"), exports);
|
|
61
72
|
__exportStar(require("./ConversationAttachmentFiles"), exports);
|
|
62
73
|
__exportStar(require("./ConversationContacts"), exports);
|
|
63
74
|
__exportStar(require("./ConversationFirstContactReply"), exports);
|
|
@@ -74,24 +85,41 @@ __exportStar(require("./CreateDataEventRequest"), exports);
|
|
|
74
85
|
__exportStar(require("./CreateMessageRequest"), exports);
|
|
75
86
|
__exportStar(require("./CreateOrUpdateTagRequest"), exports);
|
|
76
87
|
__exportStar(require("./CreateTicketReplyWithCommentRequest"), exports);
|
|
88
|
+
__exportStar(require("./CurrentCanvas"), exports);
|
|
77
89
|
__exportStar(require("./CursorPages"), exports);
|
|
78
|
-
__exportStar(require("./CustomAttributes"), exports);
|
|
79
90
|
__exportStar(require("./CustomerRequest"), exports);
|
|
80
91
|
__exportStar(require("./DataAttributeList"), exports);
|
|
81
92
|
__exportStar(require("./DataEventList"), exports);
|
|
82
93
|
__exportStar(require("./DataEventSummary"), exports);
|
|
83
94
|
__exportStar(require("./DataEventSummaryItem"), exports);
|
|
84
95
|
__exportStar(require("./DataExportCsv"), exports);
|
|
96
|
+
__exportStar(require("./DataTableItem"), exports);
|
|
97
|
+
__exportStar(require("./DataTableComponent"), exports);
|
|
85
98
|
__exportStar(require("./DeletedArticleObject"), exports);
|
|
86
99
|
__exportStar(require("./DeletedCollectionObject"), exports);
|
|
87
100
|
__exportStar(require("./DeletedCompanyObject"), exports);
|
|
88
101
|
__exportStar(require("./DeletedObject"), exports);
|
|
102
|
+
__exportStar(require("./DividerComponent"), exports);
|
|
103
|
+
__exportStar(require("./DropdownOption"), exports);
|
|
104
|
+
__exportStar(require("./DropdownComponent"), exports);
|
|
89
105
|
__exportStar(require("./Error_"), exports);
|
|
106
|
+
__exportStar(require("./Event"), exports);
|
|
90
107
|
__exportStar(require("./FileAttribute"), exports);
|
|
91
108
|
__exportStar(require("./GroupContent"), exports);
|
|
92
109
|
__exportStar(require("./GroupTranslatedContent"), exports);
|
|
110
|
+
__exportStar(require("./ImageComponent"), exports);
|
|
111
|
+
__exportStar(require("./InitializeRequest"), exports);
|
|
112
|
+
__exportStar(require("./InitializeResponse"), exports);
|
|
113
|
+
__exportStar(require("./InputComponent"), exports);
|
|
93
114
|
__exportStar(require("./LinkedObject"), exports);
|
|
94
115
|
__exportStar(require("./LinkedObjectList"), exports);
|
|
116
|
+
__exportStar(require("./ListItem"), exports);
|
|
117
|
+
__exportStar(require("./ListItemWithImage"), exports);
|
|
118
|
+
__exportStar(require("./ListItemWithoutImage"), exports);
|
|
119
|
+
__exportStar(require("./ListComponent"), exports);
|
|
120
|
+
__exportStar(require("./LiveCanvasRequest"), exports);
|
|
121
|
+
__exportStar(require("./LiveCanvasResponse"), exports);
|
|
122
|
+
__exportStar(require("./MultipleOrSingleFilterSearchRequest"), exports);
|
|
95
123
|
__exportStar(require("./MultipleFilterSearchRequest"), exports);
|
|
96
124
|
__exportStar(require("./NewsItemRequest"), exports);
|
|
97
125
|
__exportStar(require("./NoteList"), exports);
|
|
@@ -104,13 +132,21 @@ __exportStar(require("./PhoneSwitch"), exports);
|
|
|
104
132
|
__exportStar(require("./RedactConversationRequest"), exports);
|
|
105
133
|
__exportStar(require("./Reference"), exports);
|
|
106
134
|
__exportStar(require("./ReplyConversationRequest"), exports);
|
|
135
|
+
__exportStar(require("./ResultsResponse"), exports);
|
|
107
136
|
__exportStar(require("./SearchRequest"), exports);
|
|
108
137
|
__exportStar(require("./SegmentList"), exports);
|
|
138
|
+
__exportStar(require("./SheetActionComponent"), exports);
|
|
109
139
|
__exportStar(require("./SingleFilterSearchRequest"), exports);
|
|
140
|
+
__exportStar(require("./SingleSelectOption"), exports);
|
|
141
|
+
__exportStar(require("./SingleSelectComponent"), exports);
|
|
110
142
|
__exportStar(require("./SlaApplied"), exports);
|
|
111
143
|
__exportStar(require("./SnoozeConversationRequest"), exports);
|
|
112
144
|
__exportStar(require("./SocialProfile"), exports);
|
|
145
|
+
__exportStar(require("./SpacerComponent"), exports);
|
|
113
146
|
__exportStar(require("./StartingAfterPaging"), exports);
|
|
147
|
+
__exportStar(require("./SubmitActionComponent"), exports);
|
|
148
|
+
__exportStar(require("./SubmitRequest"), exports);
|
|
149
|
+
__exportStar(require("./SubmitResponse"), exports);
|
|
114
150
|
__exportStar(require("./SubscriptionTypeList"), exports);
|
|
115
151
|
__exportStar(require("./TagCompanyRequest"), exports);
|
|
116
152
|
__exportStar(require("./TagList"), exports);
|
|
@@ -118,6 +154,8 @@ __exportStar(require("./TagMultipleUsersRequest"), exports);
|
|
|
118
154
|
__exportStar(require("./Tags"), exports);
|
|
119
155
|
__exportStar(require("./TeamList"), exports);
|
|
120
156
|
__exportStar(require("./TeamPriorityLevel"), exports);
|
|
157
|
+
__exportStar(require("./TextComponent"), exports);
|
|
158
|
+
__exportStar(require("./TextAreaComponent"), exports);
|
|
121
159
|
__exportStar(require("./TicketCustomAttributes"), exports);
|
|
122
160
|
__exportStar(require("./TicketList"), exports);
|
|
123
161
|
__exportStar(require("./TicketPartAuthor"), exports);
|
|
@@ -130,5 +168,8 @@ __exportStar(require("./TicketTypeList"), exports);
|
|
|
130
168
|
__exportStar(require("./Translation"), exports);
|
|
131
169
|
__exportStar(require("./UntagCompanyRequest"), exports);
|
|
132
170
|
__exportStar(require("./UpdateVisitorRequest"), exports);
|
|
171
|
+
__exportStar(require("./UrlActionComponent"), exports);
|
|
133
172
|
__exportStar(require("./Visitor"), exports);
|
|
134
173
|
__exportStar(require("./VisitorDeletedObject"), exports);
|
|
174
|
+
__exportStar(require("./CustomAttributes"), exports);
|
|
175
|
+
__exportStar(require("./OffsetPages"), exports);
|
package/dist/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "
|
|
1
|
+
export declare const SDK_VERSION = "v6.1.1";
|
package/dist/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "intercom-client",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "v6.1.1",
|
|
4
4
|
"private": false,
|
|
5
5
|
"repository": "https://github.com/intercom/intercom-node",
|
|
6
6
|
"main": "./index.js",
|
|
@@ -39,5 +39,13 @@
|
|
|
39
39
|
"fs": false,
|
|
40
40
|
"os": false,
|
|
41
41
|
"path": false
|
|
42
|
-
}
|
|
42
|
+
},
|
|
43
|
+
"license": "Apache-2.0",
|
|
44
|
+
"description": "Official Node bindings to the Intercom API",
|
|
45
|
+
"homepage": "https://github.com/intercom/intercom-node",
|
|
46
|
+
"bugs": "https://github.com/intercom/intercom-node/issues",
|
|
47
|
+
"keywords": [
|
|
48
|
+
"intercom",
|
|
49
|
+
"api"
|
|
50
|
+
]
|
|
43
51
|
}
|
package/reference.md
CHANGED
|
@@ -973,7 +973,7 @@ Companies will be only visible in Intercom when there is at least one associated
|
|
|
973
973
|
|
|
974
974
|
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.
|
|
975
975
|
|
|
976
|
-
{% admonition type="
|
|
976
|
+
{% admonition type="warning" name="Using `company_id`" %}
|
|
977
977
|
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.
|
|
978
978
|
{% /admonition %}
|
|
979
979
|
|
|
@@ -1109,7 +1109,7 @@ await client.companies.find({
|
|
|
1109
1109
|
|
|
1110
1110
|
You can update a single company using the Intercom provisioned `id`.
|
|
1111
1111
|
|
|
1112
|
-
{% admonition type="
|
|
1112
|
+
{% admonition type="warning" name="Using `company_id`" %}
|
|
1113
1113
|
When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.
|
|
1114
1114
|
{% /admonition %}
|
|
1115
1115
|
|
|
@@ -2400,7 +2400,6 @@ Most key listed as part of the Contacts Model are searchable, whether writeable
|
|
|
2400
2400
|
| email | String |
|
|
2401
2401
|
| email_domain | String |
|
|
2402
2402
|
| phone | String |
|
|
2403
|
-
| formatted_phone | String |
|
|
2404
2403
|
| external_id | String |
|
|
2405
2404
|
| created_at | Date (UNIX Timestamp) |
|
|
2406
2405
|
| signed_up_at | Date (UNIX Timestamp) |
|
|
@@ -2438,7 +2437,7 @@ Most key listed as part of the Contacts Model are searchable, whether writeable
|
|
|
2438
2437
|
|
|
2439
2438
|
### Accepted Operators
|
|
2440
2439
|
|
|
2441
|
-
{% admonition type="
|
|
2440
|
+
{% admonition type="warning" name="Searching based on `created_at`" %}
|
|
2442
2441
|
You cannot use the `<=` or `>=` operators to search by `created_at`.
|
|
2443
2442
|
{% /admonition %}
|
|
2444
2443
|
|
|
@@ -4300,11 +4299,9 @@ For managing conversations you can:
|
|
|
4300
4299
|
await client.conversations.manage({
|
|
4301
4300
|
conversation_id: "123",
|
|
4302
4301
|
body: {
|
|
4303
|
-
message_type: "
|
|
4302
|
+
message_type: "close",
|
|
4304
4303
|
type: "admin",
|
|
4305
4304
|
admin_id: "12345",
|
|
4306
|
-
assignee_id: "4324241",
|
|
4307
|
-
body: "Goodbye :)",
|
|
4308
4305
|
},
|
|
4309
4306
|
});
|
|
4310
4307
|
```
|
|
@@ -4353,8 +4350,11 @@ await client.conversations.manage({
|
|
|
4353
4350
|
<dl>
|
|
4354
4351
|
<dd>
|
|
4355
4352
|
|
|
4353
|
+
{% admonition type="danger" name="Deprecation of Run Assignment Rules" %}
|
|
4354
|
+
Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.
|
|
4355
|
+
{% /admonition %}
|
|
4356
4356
|
You can let a conversation be automatically assigned following assignment rules.
|
|
4357
|
-
{% admonition type="
|
|
4357
|
+
{% admonition type="warning" name="When using workflows" %}
|
|
4358
4358
|
It is not possible to use this endpoint with Workflows.
|
|
4359
4359
|
{% /admonition %}
|
|
4360
4360
|
|
|
@@ -4423,7 +4423,7 @@ await client.conversations.runAssignmentRules({
|
|
|
4423
4423
|
|
|
4424
4424
|
You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
|
|
4425
4425
|
|
|
4426
|
-
{% admonition type="
|
|
4426
|
+
{% admonition type="warning" name="Contacts without an email" %}
|
|
4427
4427
|
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`.
|
|
4428
4428
|
{% /admonition %}
|
|
4429
4429
|
|
|
@@ -4496,7 +4496,7 @@ await client.conversations.attachContactAsAdmin({
|
|
|
4496
4496
|
|
|
4497
4497
|
You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
|
|
4498
4498
|
|
|
4499
|
-
{% admonition type="
|
|
4499
|
+
{% admonition type="warning" name="Contacts without an email" %}
|
|
4500
4500
|
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`.
|
|
4501
4501
|
{% /admonition %}
|
|
4502
4502
|
|
|
@@ -5032,7 +5032,6 @@ Duplicated events are responded to using the normal `202 Accepted` code - an err
|
|
|
5032
5032
|
- Events sent about users that cannot be found will return a `404 Not Found`.
|
|
5033
5033
|
- Event lists containing duplicate events will have those duplicates ignored.
|
|
5034
5034
|
- Server errors will return a `500` response code and may contain an error message in the body.
|
|
5035
|
-
|
|
5036
5035
|
</dd>
|
|
5037
5036
|
</dl>
|
|
5038
5037
|
</dd>
|
|
@@ -5477,9 +5476,9 @@ This will return the Message model that has been created.
|
|
|
5477
5476
|
|
|
5478
5477
|
```typescript
|
|
5479
5478
|
await client.messages.create({
|
|
5480
|
-
message_type: "
|
|
5479
|
+
message_type: "email",
|
|
5481
5480
|
subject: "Thanks for everything",
|
|
5482
|
-
body: "
|
|
5481
|
+
body: "Hello there",
|
|
5483
5482
|
template: "plain",
|
|
5484
5483
|
from: {
|
|
5485
5484
|
type: "admin",
|
|
@@ -5489,8 +5488,6 @@ await client.messages.create({
|
|
|
5489
5488
|
type: "user",
|
|
5490
5489
|
id: "536e564f316c83104c000020",
|
|
5491
5490
|
},
|
|
5492
|
-
created_at: 1590000000,
|
|
5493
|
-
create_conversation_without_contact_reply: true,
|
|
5494
5491
|
});
|
|
5495
5492
|
```
|
|
5496
5493
|
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "
|
|
1
|
+
export declare const SDK_VERSION = "v6.1.1";
|
package/version.js
CHANGED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./types";
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./types"), exports);
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* 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.
|
|
6
|
-
*/
|
|
7
|
-
export interface CustomObjectInstance {
|
|
8
|
-
/** The Intercom defined id representing the custom object instance. */
|
|
9
|
-
id: string;
|
|
10
|
-
/** The id you have defined for the custom object instance. */
|
|
11
|
-
external_id?: string;
|
|
12
|
-
/** The identifier of the custom object type that defines the structure of the custom object instance. */
|
|
13
|
-
type: string;
|
|
14
|
-
/** The custom attributes you have set on the custom object instance. */
|
|
15
|
-
custom_attributes?: Record<string, string>;
|
|
16
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./CustomObjectInstance";
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./CustomObjectInstance"), exports);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./types";
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./types"), exports);
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* 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.
|
|
6
|
-
*/
|
|
7
|
-
export interface CustomObjectInstance {
|
|
8
|
-
/** The Intercom defined id representing the custom object instance. */
|
|
9
|
-
id: string;
|
|
10
|
-
/** The id you have defined for the custom object instance. */
|
|
11
|
-
external_id?: string;
|
|
12
|
-
/** The identifier of the custom object type that defines the structure of the custom object instance. */
|
|
13
|
-
type: string;
|
|
14
|
-
/** The custom attributes you have set on the custom object instance. */
|
|
15
|
-
custom_attributes?: Record<string, string>;
|
|
16
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./CustomObjectInstance";
|