intercom-client
Version:
Official Node bindings to the Intercom API
111 lines (110 loc) • 4.03 kB
text/typescript
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
import * as core from "../../../../core/index.mjs";
import * as Intercom from "../../../index.mjs";
export declare namespace MessagesClient {
interface Options extends BaseClientOptions {
}
interface RequestOptions extends BaseRequestOptions {
}
}
/**
* Everything about your messages
*/
export declare class MessagesClient {
protected readonly _options: NormalizedClientOptionsWithAuth<MessagesClient.Options>;
constructor(options?: MessagesClient.Options);
/**
* You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.
*
* > 🚧 Sending for visitors
* >
* > 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.
*
* This will return the Message model that has been created.
*
* > 🚧 Retrieving Associated Conversations
* >
* > 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.
*
* @param {Intercom.CreateMessageRequest} request
* @param {MessagesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Intercom.BadRequestError}
* @throws {@link Intercom.UnauthorizedError}
* @throws {@link Intercom.ForbiddenError}
* @throws {@link Intercom.UnprocessableEntityError}
*
* @example
* await client.messages.create({
* message_type: "email",
* subject: "Thanks for everything",
* body: "Hello there",
* template: "plain",
* from: {
* type: "admin",
* id: 394051
* },
* to: {
* type: "user",
* id: "536e564f316c83104c000020"
* }
* })
*
* @example
* await client.messages.create({
* message_type: "inapp",
* subject: "heyy",
* body: "Hello there",
* template: "plain",
* from: {
* type: "admin",
* id: 394051
* },
* to: {
* type: "user",
* id: "6762f23b1bb69f9f2193bc1a"
* },
* created_at: 1590000000,
* create_conversation_without_contact_reply: true
* })
*
* @example
* await client.messages.create({
* message_type: "email",
* subject: "Thanks for everything",
* body: "hey there",
* template: "plain",
* from: {
* type: "admin",
* id: 394051
* },
* to: {
* type: "user",
* id: "536e564f316c83104c000020"
* },
* created_at: 1590000000,
* create_conversation_without_contact_reply: true
* })
*
* @example
* await client.messages.create({
* message_type: "email",
* subject: "heyy",
* body: "Hello there",
* template: "plain",
* from: {
* type: "admin",
* id: 394051
* },
* to: {
* type: "user",
* id: "6762f23d1bb69f9f2193bc1c"
* },
* created_at: 1590000000,
* create_conversation_without_contact_reply: true
* })
*/
create(request?: Intercom.CreateMessageRequest, requestOptions?: MessagesClient.RequestOptions): core.HttpResponsePromise<Intercom.Message>;
private __create;
}