intercom-client 7.0.2 → 7.0.3
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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/contacts/types/Contact.d.ts +9 -9
- package/dist/cjs/api/resources/conversations/types/Conversation.d.ts +10 -10
- package/dist/cjs/api/resources/dataEvents/types/DataEvent.d.ts +1 -1
- package/dist/cjs/api/resources/messages/types/Message.d.ts +1 -1
- package/dist/cjs/api/resources/notes/types/Note.d.ts +4 -4
- package/dist/cjs/api/resources/tickets/types/Ticket.d.ts +6 -6
- package/dist/cjs/api/types/Visitor.d.ts +3 -3
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/contacts/types/Contact.d.mts +9 -9
- package/dist/esm/api/resources/conversations/types/Conversation.d.mts +10 -10
- package/dist/esm/api/resources/dataEvents/types/DataEvent.d.mts +1 -1
- package/dist/esm/api/resources/messages/types/Message.d.mts +1 -1
- package/dist/esm/api/resources/notes/types/Note.d.mts +4 -4
- package/dist/esm/api/resources/tickets/types/Ticket.d.mts +6 -6
- package/dist/esm/api/types/Visitor.d.mts +3 -3
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -44,8 +44,8 @@ function normalizeClientOptions(options) {
|
|
|
44
44
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
45
45
|
"X-Fern-Language": "JavaScript",
|
|
46
46
|
"X-Fern-SDK-Name": "intercom-client",
|
|
47
|
-
"X-Fern-SDK-Version": "7.0.
|
|
48
|
-
"User-Agent": "intercom-client/7.0.
|
|
47
|
+
"X-Fern-SDK-Version": "7.0.3",
|
|
48
|
+
"User-Agent": "intercom-client/7.0.3",
|
|
49
49
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
50
50
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
51
51
|
"Intercom-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2.14",
|
|
@@ -4,15 +4,15 @@ import type * as Intercom from "../../../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface Contact {
|
|
6
6
|
/** The type of object. */
|
|
7
|
-
type
|
|
7
|
+
type: "contact";
|
|
8
8
|
/** The unique identifier for the contact which is given by Intercom. */
|
|
9
|
-
id
|
|
9
|
+
id: string;
|
|
10
10
|
/** The unique identifier for the contact which is provided by the Client. */
|
|
11
11
|
external_id?: string;
|
|
12
12
|
/** The id of the workspace which the contact belongs to. */
|
|
13
|
-
workspace_id
|
|
13
|
+
workspace_id: string;
|
|
14
14
|
/** The role of the contact. */
|
|
15
|
-
role
|
|
15
|
+
role: string;
|
|
16
16
|
/** The contact's email. */
|
|
17
17
|
email?: string;
|
|
18
18
|
/** The contact's email domain. */
|
|
@@ -24,15 +24,15 @@ export interface Contact {
|
|
|
24
24
|
/** The id of an admin that has been assigned account ownership of the contact. */
|
|
25
25
|
owner_id?: number;
|
|
26
26
|
/** Whether the contact has had an email sent to them hard bounce. */
|
|
27
|
-
has_hard_bounced
|
|
27
|
+
has_hard_bounced: boolean;
|
|
28
28
|
/** Whether the contact has marked an email sent to them as spam. */
|
|
29
|
-
marked_email_as_spam
|
|
29
|
+
marked_email_as_spam: boolean;
|
|
30
30
|
/** Whether the contact is unsubscribed from emails. */
|
|
31
|
-
unsubscribed_from_emails
|
|
31
|
+
unsubscribed_from_emails: boolean;
|
|
32
32
|
/** (UNIX timestamp) The time when the contact was created. */
|
|
33
|
-
created_at
|
|
33
|
+
created_at: number;
|
|
34
34
|
/** (UNIX timestamp) The time when the contact was last updated. */
|
|
35
|
-
updated_at
|
|
35
|
+
updated_at: number;
|
|
36
36
|
/** (UNIX timestamp) The time specified for when a contact signed up. */
|
|
37
37
|
signed_up_at?: number;
|
|
38
38
|
/** (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually). */
|
|
@@ -4,25 +4,25 @@ import type * as Intercom from "../../../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface Conversation {
|
|
6
6
|
/** Always conversation. */
|
|
7
|
-
type
|
|
7
|
+
type: string;
|
|
8
8
|
/** The id representing the conversation. */
|
|
9
|
-
id
|
|
9
|
+
id: string;
|
|
10
10
|
/** The title given to the conversation. */
|
|
11
11
|
title?: string;
|
|
12
12
|
/** The time the conversation was created. */
|
|
13
|
-
created_at
|
|
13
|
+
created_at: number;
|
|
14
14
|
/** The last time the conversation was updated. */
|
|
15
|
-
updated_at
|
|
15
|
+
updated_at: number;
|
|
16
16
|
/** 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. */
|
|
17
17
|
waiting_since?: number;
|
|
18
18
|
/** 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. */
|
|
19
19
|
snoozed_until?: number;
|
|
20
20
|
/** Indicates whether a conversation is open (true) or closed (false). */
|
|
21
|
-
open
|
|
21
|
+
open: boolean;
|
|
22
22
|
/** Can be set to "open", "closed" or "snoozed". */
|
|
23
|
-
state
|
|
23
|
+
state: Conversation.State;
|
|
24
24
|
/** Indicates whether a conversation has been read. */
|
|
25
|
-
read
|
|
25
|
+
read: boolean;
|
|
26
26
|
/** If marked as priority, it will return priority or else not_priority. */
|
|
27
27
|
priority?: Conversation.Priority;
|
|
28
28
|
/** The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null. */
|
|
@@ -33,10 +33,10 @@ export interface Conversation {
|
|
|
33
33
|
company_id?: string;
|
|
34
34
|
tags?: Intercom.Tags;
|
|
35
35
|
conversation_rating?: Intercom.ConversationRating;
|
|
36
|
-
source
|
|
37
|
-
contacts
|
|
36
|
+
source: Intercom.ConversationSource;
|
|
37
|
+
contacts: Intercom.ConversationContacts;
|
|
38
38
|
teammates?: Intercom.ConversationTeammates;
|
|
39
|
-
custom_attributes
|
|
39
|
+
custom_attributes: Intercom.CustomAttributes;
|
|
40
40
|
first_contact_reply?: Intercom.ConversationFirstContactReply;
|
|
41
41
|
sla_applied?: Intercom.SlaApplied;
|
|
42
42
|
statistics?: Intercom.ConversationStatistics;
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface DataEvent {
|
|
5
5
|
/** The type of the object */
|
|
6
|
-
type
|
|
6
|
+
type: "event";
|
|
7
7
|
/** 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`. */
|
|
8
8
|
event_name: string;
|
|
9
9
|
/** The time the event occurred as a UTC Unix timestamp */
|
|
@@ -15,7 +15,7 @@ export interface Message {
|
|
|
15
15
|
/** The type of message that was sent. Can be email, inapp, facebook or twitter. */
|
|
16
16
|
message_type: Message.MessageType;
|
|
17
17
|
/** The associated conversation_id */
|
|
18
|
-
conversation_id
|
|
18
|
+
conversation_id: string;
|
|
19
19
|
}
|
|
20
20
|
export declare namespace Message {
|
|
21
21
|
/** The type of message that was sent. Can be email, inapp, facebook or twitter. */
|
|
@@ -4,17 +4,17 @@ import type * as Intercom from "../../../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface Note {
|
|
6
6
|
/** String representing the object's type. Always has the value `note`. */
|
|
7
|
-
type
|
|
7
|
+
type: string;
|
|
8
8
|
/** The id of the note. */
|
|
9
|
-
id
|
|
9
|
+
id: string;
|
|
10
10
|
/** The time the note was created. */
|
|
11
|
-
created_at
|
|
11
|
+
created_at: number;
|
|
12
12
|
/** Represents the contact that the note was created about. */
|
|
13
13
|
contact?: Note.Contact;
|
|
14
14
|
/** Optional. Represents the Admin that created the note. */
|
|
15
15
|
author?: Intercom.Admin;
|
|
16
16
|
/** The body text of the note. */
|
|
17
|
-
body
|
|
17
|
+
body: string;
|
|
18
18
|
}
|
|
19
19
|
export declare namespace Note {
|
|
20
20
|
/**
|
|
@@ -4,17 +4,17 @@ import type * as Intercom from "../../../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface Ticket {
|
|
6
6
|
/** Always ticket */
|
|
7
|
-
type
|
|
7
|
+
type: "ticket";
|
|
8
8
|
/** The unique identifier for the ticket which is given by Intercom. */
|
|
9
|
-
id
|
|
9
|
+
id: string;
|
|
10
10
|
/** The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries. */
|
|
11
|
-
ticket_id
|
|
11
|
+
ticket_id: string;
|
|
12
12
|
/** Category of the Ticket. */
|
|
13
|
-
category
|
|
14
|
-
ticket_attributes
|
|
13
|
+
category: Ticket.Category;
|
|
14
|
+
ticket_attributes: Intercom.TicketCustomAttributes;
|
|
15
15
|
ticket_state?: Intercom.TicketState;
|
|
16
16
|
ticket_type?: Intercom.TicketType;
|
|
17
|
-
contacts
|
|
17
|
+
contacts: Intercom.TicketContacts;
|
|
18
18
|
/** The id representing the admin assigned to the ticket. */
|
|
19
19
|
admin_assignee_id?: string;
|
|
20
20
|
/** The id representing the team assigned to the ticket. */
|
|
@@ -4,11 +4,11 @@ import type * as Intercom from "../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface Visitor {
|
|
6
6
|
/** Value is 'visitor' */
|
|
7
|
-
type
|
|
7
|
+
type: "visitor";
|
|
8
8
|
/** The Intercom defined id representing the Visitor. */
|
|
9
|
-
id
|
|
9
|
+
id: string;
|
|
10
10
|
/** Automatically generated identifier for the Visitor. */
|
|
11
|
-
user_id
|
|
11
|
+
user_id: string;
|
|
12
12
|
/** Identifies if this visitor is anonymous. */
|
|
13
13
|
anonymous?: boolean;
|
|
14
14
|
/** The email of the visitor. */
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "7.0.
|
|
1
|
+
export declare const SDK_VERSION = "7.0.3";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -7,8 +7,8 @@ export function normalizeClientOptions(options) {
|
|
|
7
7
|
const headers = mergeHeaders({
|
|
8
8
|
"X-Fern-Language": "JavaScript",
|
|
9
9
|
"X-Fern-SDK-Name": "intercom-client",
|
|
10
|
-
"X-Fern-SDK-Version": "7.0.
|
|
11
|
-
"User-Agent": "intercom-client/7.0.
|
|
10
|
+
"X-Fern-SDK-Version": "7.0.3",
|
|
11
|
+
"User-Agent": "intercom-client/7.0.3",
|
|
12
12
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
13
13
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
14
14
|
"Intercom-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2.14",
|
|
@@ -4,15 +4,15 @@ import type * as Intercom from "../../../index.mjs";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface Contact {
|
|
6
6
|
/** The type of object. */
|
|
7
|
-
type
|
|
7
|
+
type: "contact";
|
|
8
8
|
/** The unique identifier for the contact which is given by Intercom. */
|
|
9
|
-
id
|
|
9
|
+
id: string;
|
|
10
10
|
/** The unique identifier for the contact which is provided by the Client. */
|
|
11
11
|
external_id?: string;
|
|
12
12
|
/** The id of the workspace which the contact belongs to. */
|
|
13
|
-
workspace_id
|
|
13
|
+
workspace_id: string;
|
|
14
14
|
/** The role of the contact. */
|
|
15
|
-
role
|
|
15
|
+
role: string;
|
|
16
16
|
/** The contact's email. */
|
|
17
17
|
email?: string;
|
|
18
18
|
/** The contact's email domain. */
|
|
@@ -24,15 +24,15 @@ export interface Contact {
|
|
|
24
24
|
/** The id of an admin that has been assigned account ownership of the contact. */
|
|
25
25
|
owner_id?: number;
|
|
26
26
|
/** Whether the contact has had an email sent to them hard bounce. */
|
|
27
|
-
has_hard_bounced
|
|
27
|
+
has_hard_bounced: boolean;
|
|
28
28
|
/** Whether the contact has marked an email sent to them as spam. */
|
|
29
|
-
marked_email_as_spam
|
|
29
|
+
marked_email_as_spam: boolean;
|
|
30
30
|
/** Whether the contact is unsubscribed from emails. */
|
|
31
|
-
unsubscribed_from_emails
|
|
31
|
+
unsubscribed_from_emails: boolean;
|
|
32
32
|
/** (UNIX timestamp) The time when the contact was created. */
|
|
33
|
-
created_at
|
|
33
|
+
created_at: number;
|
|
34
34
|
/** (UNIX timestamp) The time when the contact was last updated. */
|
|
35
|
-
updated_at
|
|
35
|
+
updated_at: number;
|
|
36
36
|
/** (UNIX timestamp) The time specified for when a contact signed up. */
|
|
37
37
|
signed_up_at?: number;
|
|
38
38
|
/** (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually). */
|
|
@@ -4,25 +4,25 @@ import type * as Intercom from "../../../index.mjs";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface Conversation {
|
|
6
6
|
/** Always conversation. */
|
|
7
|
-
type
|
|
7
|
+
type: string;
|
|
8
8
|
/** The id representing the conversation. */
|
|
9
|
-
id
|
|
9
|
+
id: string;
|
|
10
10
|
/** The title given to the conversation. */
|
|
11
11
|
title?: string;
|
|
12
12
|
/** The time the conversation was created. */
|
|
13
|
-
created_at
|
|
13
|
+
created_at: number;
|
|
14
14
|
/** The last time the conversation was updated. */
|
|
15
|
-
updated_at
|
|
15
|
+
updated_at: number;
|
|
16
16
|
/** 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. */
|
|
17
17
|
waiting_since?: number;
|
|
18
18
|
/** 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. */
|
|
19
19
|
snoozed_until?: number;
|
|
20
20
|
/** Indicates whether a conversation is open (true) or closed (false). */
|
|
21
|
-
open
|
|
21
|
+
open: boolean;
|
|
22
22
|
/** Can be set to "open", "closed" or "snoozed". */
|
|
23
|
-
state
|
|
23
|
+
state: Conversation.State;
|
|
24
24
|
/** Indicates whether a conversation has been read. */
|
|
25
|
-
read
|
|
25
|
+
read: boolean;
|
|
26
26
|
/** If marked as priority, it will return priority or else not_priority. */
|
|
27
27
|
priority?: Conversation.Priority;
|
|
28
28
|
/** The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null. */
|
|
@@ -33,10 +33,10 @@ export interface Conversation {
|
|
|
33
33
|
company_id?: string;
|
|
34
34
|
tags?: Intercom.Tags;
|
|
35
35
|
conversation_rating?: Intercom.ConversationRating;
|
|
36
|
-
source
|
|
37
|
-
contacts
|
|
36
|
+
source: Intercom.ConversationSource;
|
|
37
|
+
contacts: Intercom.ConversationContacts;
|
|
38
38
|
teammates?: Intercom.ConversationTeammates;
|
|
39
|
-
custom_attributes
|
|
39
|
+
custom_attributes: Intercom.CustomAttributes;
|
|
40
40
|
first_contact_reply?: Intercom.ConversationFirstContactReply;
|
|
41
41
|
sla_applied?: Intercom.SlaApplied;
|
|
42
42
|
statistics?: Intercom.ConversationStatistics;
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface DataEvent {
|
|
5
5
|
/** The type of the object */
|
|
6
|
-
type
|
|
6
|
+
type: "event";
|
|
7
7
|
/** 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`. */
|
|
8
8
|
event_name: string;
|
|
9
9
|
/** The time the event occurred as a UTC Unix timestamp */
|
|
@@ -15,7 +15,7 @@ export interface Message {
|
|
|
15
15
|
/** The type of message that was sent. Can be email, inapp, facebook or twitter. */
|
|
16
16
|
message_type: Message.MessageType;
|
|
17
17
|
/** The associated conversation_id */
|
|
18
|
-
conversation_id
|
|
18
|
+
conversation_id: string;
|
|
19
19
|
}
|
|
20
20
|
export declare namespace Message {
|
|
21
21
|
/** The type of message that was sent. Can be email, inapp, facebook or twitter. */
|
|
@@ -4,17 +4,17 @@ import type * as Intercom from "../../../index.mjs";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface Note {
|
|
6
6
|
/** String representing the object's type. Always has the value `note`. */
|
|
7
|
-
type
|
|
7
|
+
type: string;
|
|
8
8
|
/** The id of the note. */
|
|
9
|
-
id
|
|
9
|
+
id: string;
|
|
10
10
|
/** The time the note was created. */
|
|
11
|
-
created_at
|
|
11
|
+
created_at: number;
|
|
12
12
|
/** Represents the contact that the note was created about. */
|
|
13
13
|
contact?: Note.Contact;
|
|
14
14
|
/** Optional. Represents the Admin that created the note. */
|
|
15
15
|
author?: Intercom.Admin;
|
|
16
16
|
/** The body text of the note. */
|
|
17
|
-
body
|
|
17
|
+
body: string;
|
|
18
18
|
}
|
|
19
19
|
export declare namespace Note {
|
|
20
20
|
/**
|
|
@@ -4,17 +4,17 @@ import type * as Intercom from "../../../index.mjs";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface Ticket {
|
|
6
6
|
/** Always ticket */
|
|
7
|
-
type
|
|
7
|
+
type: "ticket";
|
|
8
8
|
/** The unique identifier for the ticket which is given by Intercom. */
|
|
9
|
-
id
|
|
9
|
+
id: string;
|
|
10
10
|
/** The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries. */
|
|
11
|
-
ticket_id
|
|
11
|
+
ticket_id: string;
|
|
12
12
|
/** Category of the Ticket. */
|
|
13
|
-
category
|
|
14
|
-
ticket_attributes
|
|
13
|
+
category: Ticket.Category;
|
|
14
|
+
ticket_attributes: Intercom.TicketCustomAttributes;
|
|
15
15
|
ticket_state?: Intercom.TicketState;
|
|
16
16
|
ticket_type?: Intercom.TicketType;
|
|
17
|
-
contacts
|
|
17
|
+
contacts: Intercom.TicketContacts;
|
|
18
18
|
/** The id representing the admin assigned to the ticket. */
|
|
19
19
|
admin_assignee_id?: string;
|
|
20
20
|
/** The id representing the team assigned to the ticket. */
|
|
@@ -4,11 +4,11 @@ import type * as Intercom from "../index.mjs";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface Visitor {
|
|
6
6
|
/** Value is 'visitor' */
|
|
7
|
-
type
|
|
7
|
+
type: "visitor";
|
|
8
8
|
/** The Intercom defined id representing the Visitor. */
|
|
9
|
-
id
|
|
9
|
+
id: string;
|
|
10
10
|
/** Automatically generated identifier for the Visitor. */
|
|
11
|
-
user_id
|
|
11
|
+
user_id: string;
|
|
12
12
|
/** Identifies if this visitor is anonymous. */
|
|
13
13
|
anonymous?: boolean;
|
|
14
14
|
/** The email of the visitor. */
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "7.0.
|
|
1
|
+
export declare const SDK_VERSION = "7.0.3";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "7.0.
|
|
1
|
+
export const SDK_VERSION = "7.0.3";
|