intercom-client 6.0.0-alpha → 6.0.0-beta.2

package/resources/tickets/tickets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tickets.js","sourceRoot":"","sources":["../../src/resources/tickets/tickets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,mDAAkC;AAElC,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsLtD,CAAC;IApLC;;OAEG;IACH,MAAM,CAAC,MAA0B,EAAE,OAA6B;QAC9D,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,EAAU,EAAE,MAAyB,EAAE,OAA6B;QACxE,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAWD,YAAY,CACV,EAAU,EACV,SAAyD,EAAE,EAC3D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SAC1C;QACD,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE;YACxC,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,MAAM,CAAC,MAA0B,EAAE,OAA6B;QAC9D,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC1C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAWD,UAAU,CACR,EAAU,EACV,SAAuD,EAAE,EACzD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SACxC;QACD,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE;YACxC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAvLD,0BAuLC;AAgkBD,WAAiB,OAAO;IAQR,YAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AAGpC,CAAC,EAXgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAWvB"}

package/resources/tickets/tickets.mjs

@@ -0,0 +1,164 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../resource.mjs";
+import { isRequestOptions } from "../../core.mjs";
+import * as TagsAPI from "./tags.mjs";
+export class Tickets extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.tags = new TagsAPI.Tags(this._client);
+    }
+    /**
+     * You can create a new ticket.
+     */
+    create(params, options) {
+        const { 'Intercom-Version': intercomVersion, ...body } = params;
+        return this._client.post('/tickets', {
+            body,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+    /**
+     * You can reply to a ticket with a message from an admin or on behalf of a
+     * contact, or with a note for admins.
+     */
+    reply(id, params, options) {
+        const { 'Intercom-Version': intercomVersion, ...body } = params;
+        return this._client.post(`/tickets/${id}/reply`, {
+            body,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+    retrieveById(id, params = {}, options) {
+        if (isRequestOptions(params)) {
+            return this.retrieveById(id, {}, params);
+        }
+        const { 'Intercom-Version': intercomVersion } = params;
+        return this._client.get(`/tickets/${id}`, {
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+    /**
+     * 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                                                  |
+     */
+    search(params, options) {
+        const { 'Intercom-Version': intercomVersion, ...body } = params;
+        return this._client.post('/tickets/search', {
+            body,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+    updateById(id, params = {}, options) {
+        if (isRequestOptions(params)) {
+            return this.updateById(id, {}, params);
+        }
+        const { 'Intercom-Version': intercomVersion, ...body } = params;
+        return this._client.put(`/tickets/${id}`, {
+            body,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+}
+(function (Tickets) {
+    Tickets.Tags = TagsAPI.Tags;
+})(Tickets || (Tickets = {}));
+//# sourceMappingURL=tickets.mjs.map

package/resources/tickets/tickets.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tickets.mjs","sourceRoot":"","sources":["../../src/resources/tickets/tickets.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,KAAK,OAAO;AAEnB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsLtD,CAAC;IApLC;;OAEG;IACH,MAAM,CAAC,MAA0B,EAAE,OAA6B;QAC9D,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,EAAU,EAAE,MAAyB,EAAE,OAA6B;QACxE,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAWD,YAAY,CACV,EAAU,EACV,SAAyD,EAAE,EAC3D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SAC1C;QACD,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE;YACxC,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,MAAM,CAAC,MAA0B,EAAE,OAA6B;QAC9D,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC1C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAWD,UAAU,CACR,EAAU,EACV,SAAuD,EAAE,EACzD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SACxC;QACD,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE;YACxC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAgkBD,WAAiB,OAAO;IAQR,YAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AAGpC,CAAC,EAXgB,OAAO,KAAP,OAAO,QAWvB"}

package/resources/visitors.d.ts

@@ -0,0 +1,355 @@
+import { APIResource } from "../resource.js";
+import * as Core from "../core.js";
+import * as VisitorsAPI from "./visitors.js";
+import * as Shared from "./shared.js";
+export declare class Visitors extends APIResource {
+    /**
+     * You can fetch the details of a single visitor.
+     */
+    retrieve(params: VisitorRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Visitor | null>;
+    /**
+     * 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.
+     */
+    update(params: VisitorUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Visitor | null>;
+    /**
+     * You can merge a Visitor to a Contact of role type `lead` or `user`.
+     *
+     * > 📘 What happens upon a visitor being converted?
+     * >
+     * > 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.
+     */
+    convert(params: VisitorConvertParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Contact>;
+}
+/**
+ * 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.
+ */
+export interface Visitor {
+    /**
+     * The Intercom defined id representing the Visitor.
+     */
+    id?: string;
+    /**
+     * Identifies if this visitor is anonymous.
+     */
+    anonymous?: boolean;
+    /**
+     * The id of the app the visitor is associated with.
+     */
+    app_id?: string;
+    avatar?: Visitor.Avatar;
+    companies?: Visitor.Companies;
+    /**
+     * The time the Visitor was added to Intercom.
+     */
+    created_at?: number;
+    /**
+     * The custom attributes you have set on the Visitor.
+     */
+    custom_attributes?: Record<string, string>;
+    /**
+     * Identifies if this visitor has do not track enabled.
+     */
+    do_not_track?: boolean | null;
+    /**
+     * The email of the visitor.
+     */
+    email?: string;
+    /**
+     * Identifies if this visitor has had a hard bounce.
+     */
+    has_hard_bounced?: boolean;
+    /**
+     * The time the Lead last recorded making a request.
+     */
+    las_request_at?: number;
+    location_data?: Visitor.LocationData;
+    /**
+     * Identifies if this visitor has marked an email as spam.
+     */
+    marked_email_as_spam?: boolean;
+    /**
+     * The name of the visitor.
+     */
+    name?: string | null;
+    /**
+     * The id of the admin that owns the Visitor.
+     */
+    owner_id?: string | null;
+    /**
+     * The phone number of the visitor.
+     */
+    phone?: string | null;
+    /**
+     * The pseudonym of the visitor.
+     */
+    pseudonym?: string | null;
+    /**
+     * The referer of the visitor.
+     */
+    referrer?: string | null;
+    /**
+     * The time the Visitor was added to Intercom.
+     */
+    remote_created_at?: number;
+    segments?: Visitor.Segments;
+    /**
+     * The number of sessions the Visitor has had.
+     */
+    session_count?: number;
+    /**
+     * The time the Visitor signed up for your product.
+     */
+    signed_up_at?: number;
+    social_profiles?: Visitor.SocialProfiles;
+    tags?: Visitor.Tags;
+    /**
+     * Value is 'visitor'
+     */
+    type?: string;
+    /**
+     * Whether the Visitor is unsubscribed from emails.
+     */
+    unsubscribed_from_emails?: boolean;
+    /**
+     * The last time the Visitor was updated.
+     */
+    updated_at?: number;
+    /**
+     * Automatically generated identifier for the Visitor.
+     */
+    user_id?: string;
+    /**
+     * The utm_campaign of the visitor.
+     */
+    utm_campaign?: string | null;
+    /**
+     * The utm_content of the visitor.
+     */
+    utm_content?: string | null;
+    /**
+     * The utm_medium of the visitor.
+     */
+    utm_medium?: string | null;
+    /**
+     * The utm_source of the visitor.
+     */
+    utm_source?: string | null;
+    /**
+     * The utm_term of the visitor.
+     */
+    utm_term?: string | null;
+}
+export declare namespace Visitor {
+    interface Avatar {
+        /**
+         * This object represents the avatar associated with the visitor.
+         */
+        image_url?: string | null;
+        type?: string;
+    }
+    interface Companies {
+        companies?: Array<Shared.Company>;
+        /**
+         * The type of the object
+         */
+        type?: 'company.list';
+    }
+    interface LocationData {
+        /**
+         * The city name of the visitor.
+         */
+        city_name?: string;
+        /**
+         * The continent code of the visitor.
+         */
+        continent_code?: string;
+        /**
+         * The country code of the visitor.
+         */
+        country_code?: string;
+        /**
+         * The country name of the visitor.
+         */
+        country_name?: string;
+        /**
+         * The postal code of the visitor.
+         */
+        postal_code?: string;
+        /**
+         * The region name of the visitor.
+         */
+        region_name?: string;
+        /**
+         * The timezone of the visitor.
+         */
+        timezone?: string;
+        type?: string;
+    }
+    interface Segments {
+        segments?: Array<string>;
+        /**
+         * The type of the object
+         */
+        type?: 'segment.list';
+    }
+    interface SocialProfiles {
+        social_profiles?: Array<string>;
+        /**
+         * The type of the object
+         */
+        type?: 'social_profile.list';
+    }
+    interface Tags {
+        tags?: Array<Tags.Tag>;
+        /**
+         * The type of the object
+         */
+        type?: 'tag.list';
+    }
+    namespace Tags {
+        interface Tag {
+            /**
+             * The id of the tag.
+             */
+            id?: string;
+            /**
+             * The name of the tag.
+             */
+            name?: string;
+            /**
+             * The type of the object
+             */
+            type?: 'tag';
+        }
+    }
+}
+/**
+ * Response returned when an object is deleted
+ */
+export interface VisitorDeletedObject {
+    /**
+     * The unique identifier for the visitor which is given by Intercom.
+     */
+    id?: string;
+    /**
+     * The type of object which was deleted
+     */
+    type?: 'visitor';
+    /**
+     * Automatically generated identifier for the Visitor.
+     */
+    user_id?: string;
+}
+export interface VisitorRetrieveParams {
+    /**
+     * Query param: The user_id of the Visitor you want to retrieve.
+     */
+    user_id: string;
+    /**
+     * Header param: Intercom API version.By default, it's equal to the version set in
+     * the app package.
+     */
+    'Intercom-Version'?: '1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | 'Unstable';
+}
+export type VisitorUpdateParams = VisitorUpdateParams.Variant0 | VisitorUpdateParams.Variant1;
+export declare namespace VisitorUpdateParams {
+    interface Variant0 {
+        /**
+         * Body param:
+         */
+        body: unknown;
+        /**
+         * Header param: Intercom API version.By default, it's equal to the version set in
+         * the app package.
+         */
+        'Intercom-Version'?: '1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | 'Unstable';
+    }
+    interface Variant1 {
+        /**
+         * Body param:
+         */
+        body: unknown;
+        /**
+         * Header param: Intercom API version.By default, it's equal to the version set in
+         * the app package.
+         */
+        'Intercom-Version'?: '1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | 'Unstable';
+    }
+}
+export interface VisitorConvertParams {
+    /**
+     * Body param: Represents the role of the Contact model. Accepts `lead` or `user`.
+     */
+    type: string;
+    /**
+     * Body param: The unique identifiers retained after converting or merging.
+     */
+    user: VisitorConvertParams.User;
+    /**
+     * Body param: The unique identifiers to convert a single Visitor.
+     */
+    visitor: VisitorConvertParams.Visitor;
+    /**
+     * Header param: Intercom API version.By default, it's equal to the version set in
+     * the app package.
+     */
+    'Intercom-Version'?: '1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | 'Unstable';
+}
+export declare namespace VisitorConvertParams {
+    /**
+     * The unique identifiers retained after converting or merging.
+     */
+    interface User {
+        /**
+         * The unique identifier for the contact which is given by Intercom.
+         */
+        id?: string;
+        /**
+         * The contact's email, retained by default if one is present.
+         */
+        email?: string;
+        /**
+         * A unique identifier for the contact which is given to Intercom, which will be
+         * represented as external_id.
+         */
+        user_id?: string;
+    }
+    /**
+     * The unique identifiers to convert a single Visitor.
+     */
+    interface Visitor {
+        /**
+         * The unique identifier for the contact which is given by Intercom.
+         */
+        id?: string;
+        /**
+         * The visitor's email.
+         */
+        email?: string;
+        /**
+         * A unique identifier for the contact which is given to Intercom.
+         */
+        user_id?: string;
+    }
+}
+export declare namespace Visitors {
+    export import Visitor = VisitorsAPI.Visitor;
+    export import VisitorDeletedObject = VisitorsAPI.VisitorDeletedObject;
+    export import VisitorRetrieveParams = VisitorsAPI.VisitorRetrieveParams;
+    export import VisitorUpdateParams = VisitorsAPI.VisitorUpdateParams;
+    export import VisitorConvertParams = VisitorsAPI.VisitorConvertParams;
+}
+//# sourceMappingURL=visitors.d.ts.map

package/resources/visitors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visitors.d.ts","sourceRoot":"","sources":["../src/resources/visitors.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;IAcvG;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;IAcnG;;;;;;;;;OASG;IACH,OAAO,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;CAatG;AAED;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC;IAExB,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,aAAa,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;IAErC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,eAAe,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC;IAEzC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,OAAO,CAAC;IACvB,UAAiB,MAAM;QACrB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,SAAS;QACxB,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAElC;;WAEG;QACH,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,QAAQ;QACvB,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,cAAc,CAAC;KACvB;IAED,UAAiB,cAAc;QAC7B,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC;;WAEG;QACH,IAAI,CAAC,EAAE,qBAAqB,CAAC;KAC9B;IAED,UAAiB,IAAI;QACnB,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEvB;;WAEG;QACH,IAAI,CAAC,EAAE,UAAU,CAAC;KACnB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,GAAG;YAClB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,CAAC,EAAE,KAAK,CAAC;SACd;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,kBAAkB,CAAC,EACf,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,MAAM,GACN,UAAU,CAAC;CAChB;AAED,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,CAAC,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC;AAE9F,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,QAAQ;QACvB;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;;WAGG;QACH,kBAAkB,CAAC,EACf,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,MAAM,GACN,UAAU,CAAC;KAChB;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;;WAGG;QACH,kBAAkB,CAAC,EACf,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,MAAM,GACN,UAAU,CAAC;KAChB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC;IAEtC;;;OAGG;IACH,kBAAkB,CAAC,EACf,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,MAAM,GACN,UAAU,CAAC;CAChB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,yBAAiB,QAAQ,CAAC;IACxB,MAAM,QAAQ,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;IAC5C,MAAM,QAAQ,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC;IACtE,MAAM,QAAQ,qBAAqB,GAAG,WAAW,CAAC,qBAAqB,CAAC;IACxE,MAAM,QAAQ,mBAAmB,GAAG,WAAW,CAAC,mBAAmB,CAAC;IACpE,MAAM,QAAQ,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC;CACvE"}

package/resources/visitors.js

@@ -0,0 +1,73 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Visitors = void 0;
+const resource_1 = require("../resource.js");
+class Visitors extends resource_1.APIResource {
+    /**
+     * You can fetch the details of a single visitor.
+     */
+    retrieve(params, options) {
+        const { 'Intercom-Version': intercomVersion, ...query } = params;
+        return this._client.get('/visitors', {
+            query,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+    /**
+     * 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.
+     */
+    update(params, options) {
+        const { body, 'Intercom-Version': intercomVersion } = params;
+        return this._client.put('/visitors', {
+            body: body,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+    /**
+     * You can merge a Visitor to a Contact of role type `lead` or `user`.
+     *
+     * > 📘 What happens upon a visitor being converted?
+     * >
+     * > 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.
+     */
+    convert(params, options) {
+        const { 'Intercom-Version': intercomVersion, ...body } = params;
+        return this._client.post('/visitors/convert', {
+            body,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+}
+exports.Visitors = Visitors;
+(function (Visitors) {
+})(Visitors = exports.Visitors || (exports.Visitors = {}));
+//# sourceMappingURL=visitors.js.map

package/resources/visitors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visitors.js","sourceRoot":"","sources":["../src/resources/visitors.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAK1C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;OAEG;IACH,QAAQ,CAAC,MAA6B,EAAE,OAA6B;QACnE,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE;YACnC,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAA2B,EAAE,OAA6B;QAC/D,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE;YACnC,IAAI,EAAE,IAAI;YACV,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,MAA4B,EAAE,OAA6B;QACjE,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE;YAC5C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;oBACvC,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACrD,CAAC,CAAC,SAAS,CAAC;gBACZ,GAAG,OAAO,EAAE,OAAO;aACpB;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAjED,4BAiEC;AA+cD,WAAiB,QAAQ;AAMzB,CAAC,EANgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAMxB"}