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

package/resources/tickets/tickets.d.ts

@@ -0,0 +1,472 @@
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import * as TicketsAPI from "./tickets.js";
+import * as Shared from "../shared.js";
+import * as TagsAPI from "./tags.js";
+export declare class Tickets extends APIResource {
+    tags: TagsAPI.Tags;
+    /**
+     * You can create a new ticket.
+     */
+    create(params: TicketCreateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Ticket | null>;
+    /**
+     * 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: string, params: TicketReplyParams, options?: Core.RequestOptions): Core.APIPromise<TicketReply>;
+    /**
+     * You can fetch the details of a single ticket.
+     */
+    retrieveById(id: string, params?: TicketRetrieveByIDParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Ticket | null>;
+    retrieveById(id: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Ticket | null>;
+    /**
+     * 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: TicketSearchParams, options?: Core.RequestOptions): Core.APIPromise<TicketList>;
+    /**
+     * You can update a ticket.
+     */
+    updateById(id: string, params?: TicketUpdateByIDParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Ticket | null>;
+    updateById(id: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Ticket | null>;
+}
+/**
+ * Tickets are how you track requests from your users.
+ */
+export interface TicketList {
+    /**
+     * Cursor-based pagination is a technique used in the Intercom API to navigate
+     * through large amounts of data. A "cursor" or pointer is used to keep track of
+     * the current position in the result set, allowing the API to return the data in
+     * small chunks or "pages" as needed.
+     */
+    pages?: Shared.CursorPages | null;
+    /**
+     * The list of ticket objects
+     */
+    tickets?: Array<Shared.Ticket | null>;
+    /**
+     * A count of the total number of objects.
+     */
+    total_count?: number;
+    /**
+     * Always ticket.list
+     */
+    type?: 'ticket.list';
+}
+/**
+ * A Ticket Part representing a note, comment, or quick_reply on a ticket
+ */
+export interface TicketReply {
+    /**
+     * The id representing the part.
+     */
+    id?: string;
+    /**
+     * A list of attachments for the part.
+     */
+    attachments?: Array<Shared.PartAttachment>;
+    /**
+     * The author that wrote or triggered the part. Can be a bot, admin, team or user.
+     */
+    author?: TicketReply.Author;
+    /**
+     * The message body, which may contain HTML.
+     */
+    body?: string | null;
+    /**
+     * The time the note was created.
+     */
+    created_at?: number;
+    /**
+     * Type of the part
+     */
+    part_type?: 'note' | 'comment' | 'quick_reply';
+    /**
+     * Whether or not the ticket part has been redacted.
+     */
+    redacted?: boolean;
+    /**
+     * Always ticket_part
+     */
+    type?: 'ticket_part';
+    /**
+     * The last time the note was updated.
+     */
+    updated_at?: number;
+}
+export declare namespace TicketReply {
+    /**
+     * The author that wrote or triggered the part. Can be a bot, admin, team or user.
+     */
+    interface Author {
+        /**
+         * The id of the author
+         */
+        id?: string;
+        /**
+         * The email of the author
+         */
+        email?: string;
+        /**
+         * The name of the author
+         */
+        name?: string | null;
+        /**
+         * The type of the author
+         */
+        type?: 'admin' | 'bot' | 'team' | 'user';
+    }
+}
+export interface TicketCreateParams {
+    /**
+     * Body param: The list of contacts (users or leads) affected by this ticket.
+     * Currently only one is allowed
+     */
+    contacts: Array<TicketCreateParams.ID | TicketCreateParams.ExternalID | TicketCreateParams.Email>;
+    /**
+     * Body param: The ID of the type of ticket you want to create
+     */
+    ticket_type_id: string;
+    /**
+     * Body param: The ID of the company that the ticket is associated with. The ID
+     * that you set upon company creation.
+     */
+    company_id?: string;
+    /**
+     * Body param: The time the ticket was created. If not provided, the current time
+     * will be used.
+     */
+    created_at?: number;
+    /**
+     * Body param: The attributes set on the ticket. When setting the default title and
+     * description attributes, the attribute keys that should be used are
+     * `_default_title_` and `_default_description_`. When setting ticket type
+     * attributes of the list attribute type, the key should be the attribute name and
+     * the value of the attribute should be the list item id, obtainable by
+     * [listing the ticket type](ref:get_ticket-types). For example, if the ticket type
+     * has an attribute called `priority` of type `list`, the key should be `priority`
+     * and the value of the attribute should be the guid of the list item (e.g.
+     * `de1825a0-0164-4070-8ca6-13e22462fa7e`).
+     */
+    ticket_attributes?: Record<string, string | null | number | boolean | Array<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 declare namespace TicketCreateParams {
+    interface ID {
+        /**
+         * The identifier for the contact as given by Intercom.
+         */
+        id: string;
+    }
+    interface ExternalID {
+        /**
+         * The external_id you have defined for the contact who is being added as a
+         * participant.
+         */
+        external_id: string;
+    }
+    interface Email {
+        /**
+         * The email you have defined for the contact who is being added as a participant.
+         * If a contact with this email does not exist, one will be created.
+         */
+        email: string;
+    }
+}
+export type TicketReplyParams = TicketReplyParams.ContactReplyTicketIntercomUserIDRequest | TicketReplyParams.ContactReplyTicketUserIDRequest | TicketReplyParams.ContactReplyTicketEmailRequest | TicketReplyParams.AdminReplyTicketRequest;
+export declare namespace TicketReplyParams {
+    interface ContactReplyTicketIntercomUserIDRequest {
+        /**
+         * Body param: The text body of the comment.
+         */
+        body: string;
+        /**
+         * Body param:
+         */
+        message_type: 'comment';
+        /**
+         * Body param:
+         */
+        type: 'user';
+        /**
+         * Body param: A list of image URLs that will be added as attachments. You can
+         * include up to 10 URLs.
+         */
+        attachment_urls?: Array<string>;
+        /**
+         * Body param: The time the reply was created. If not provided, the current time
+         * will be used.
+         */
+        created_at?: number;
+        /**
+         * 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 ContactReplyTicketUserIDRequest {
+        /**
+         * Body param: The text body of the comment.
+         */
+        body: string;
+        /**
+         * Body param:
+         */
+        message_type: 'comment';
+        /**
+         * Body param:
+         */
+        type: 'user';
+        /**
+         * Body param: A list of image URLs that will be added as attachments. You can
+         * include up to 10 URLs.
+         */
+        attachment_urls?: Array<string>;
+        /**
+         * Body param: The time the reply was created. If not provided, the current time
+         * will be used.
+         */
+        created_at?: number;
+        /**
+         * 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 ContactReplyTicketEmailRequest {
+        /**
+         * Body param: The text body of the comment.
+         */
+        body: string;
+        /**
+         * Body param:
+         */
+        message_type: 'comment';
+        /**
+         * Body param:
+         */
+        type: 'user';
+        /**
+         * Body param: A list of image URLs that will be added as attachments. You can
+         * include up to 10 URLs.
+         */
+        attachment_urls?: Array<string>;
+        /**
+         * Body param: The time the reply was created. If not provided, the current time
+         * will be used.
+         */
+        created_at?: number;
+        /**
+         * 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 AdminReplyTicketRequest {
+        /**
+         * Body param: The id of the admin who is authoring the comment.
+         */
+        admin_id: string;
+        /**
+         * Body param:
+         */
+        message_type: 'comment' | 'note' | 'quick_reply';
+        /**
+         * Body param:
+         */
+        type: 'admin';
+        /**
+         * Body param: A list of image URLs that will be added as attachments. You can
+         * include up to 10 URLs.
+         */
+        attachment_urls?: Array<string>;
+        /**
+         * Body param: The text body of the reply. Notes accept some HTML formatting. Must
+         * be present for comment and note message types.
+         */
+        body?: string;
+        /**
+         * Body param: The time the reply was created. If not provided, the current time
+         * will be used.
+         */
+        created_at?: number;
+        /**
+         * Body param: The quick reply options to display. Must be present for quick_reply
+         * message types.
+         */
+        reply_options?: Array<TicketReplyParams.AdminReplyTicketRequest.ReplyOption>;
+        /**
+         * 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';
+    }
+    namespace AdminReplyTicketRequest {
+        interface ReplyOption {
+            /**
+             * The text to display in this quick reply option.
+             */
+            text: string;
+            /**
+             * A unique identifier for this quick reply option. This value will be available
+             * within the metadata of the comment ticket part that is created when a user
+             * clicks on this reply option.
+             */
+            uuid: string;
+        }
+    }
+}
+export interface TicketRetrieveByIDParams {
+    /**
+     * 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 TicketSearchParams {
+    /**
+     * Body param: Search using Intercoms Search APIs with a single filter.
+     */
+    query: Shared.SingleFilterSearchRequest | Shared.MultipleFilterSearchRequest;
+    /**
+     * Body param:
+     */
+    pagination?: Shared.StartingAfterPaging | null;
+    /**
+     * 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 TicketUpdateByIDParams {
+    /**
+     * Body param:
+     */
+    assignment?: TicketUpdateByIDParams.Assignment;
+    /**
+     * Body param: Specify whether the ticket is visible to users.
+     */
+    is_shared?: boolean;
+    /**
+     * Body param: Specify if a ticket is open. Set to false to close a ticket. Closing
+     * a ticket will also unsnooze it.
+     */
+    open?: boolean;
+    /**
+     * Body param: The time you want the ticket to reopen.
+     */
+    snoozed_until?: number;
+    /**
+     * Body param: The state of the ticket.
+     */
+    state?: 'in_progress' | 'waiting_on_customer' | 'resolved';
+    /**
+     * Body param: The attributes set on the ticket.
+     */
+    ticket_attributes?: 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 declare namespace TicketUpdateByIDParams {
+    interface Assignment {
+        /**
+         * The ID of the admin performing the action.
+         */
+        admin_id?: string;
+        /**
+         * The ID of the admin or team to which the ticket is assigned. Set this 0 to
+         * unassign it.
+         */
+        assignee_id?: string;
+    }
+}
+export declare namespace Tickets {
+    export import TicketList = TicketsAPI.TicketList;
+    export import TicketReply = TicketsAPI.TicketReply;
+    export import TicketCreateParams = TicketsAPI.TicketCreateParams;
+    export import TicketReplyParams = TicketsAPI.TicketReplyParams;
+    export import TicketRetrieveByIDParams = TicketsAPI.TicketRetrieveByIDParams;
+    export import TicketSearchParams = TicketsAPI.TicketSearchParams;
+    export import TicketUpdateByIDParams = TicketsAPI.TicketUpdateByIDParams;
+    export import Tags = TagsAPI.Tags;
+    export import TagCreateParams = TagsAPI.TagCreateParams;
+    export import TagRemoveParams = TagsAPI.TagRemoveParams;
+}
+//# sourceMappingURL=tickets.d.ts.map

package/resources/tickets/tickets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tickets.d.ts","sourceRoot":"","sources":["../../src/resources/tickets/tickets.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAElC,qBAAa,OAAQ,SAAQ,WAAW;IACtC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IAEpD;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IAcxG;;;OAGG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IAczG;;OAEG;IACH,YAAY,CACV,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,wBAAwB,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IACxC,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IAqB9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,MAAM,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;IAc9F;;OAEG;IACH,UAAU,CACR,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,sBAAsB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IACxC,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;CAqB7F;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAE3C;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,aAAa,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;KAC1C;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,EAAE,GAAG,kBAAkB,CAAC,UAAU,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAElG;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAEtF;;;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,kBAAkB,CAAC;IAClC,UAAiB,EAAE;QACjB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED,UAAiB,UAAU;QACzB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,KAAK;QACpB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,MAAM,iBAAiB,GACzB,iBAAiB,CAAC,uCAAuC,GACzD,iBAAiB,CAAC,+BAA+B,GACjD,iBAAiB,CAAC,8BAA8B,GAChD,iBAAiB,CAAC,uBAAuB,CAAC;AAE9C,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,uCAAuC;QACtD;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,EAAE,SAAS,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;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,+BAA+B;QAC9C;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,EAAE,SAAS,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;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,8BAA8B;QAC7C;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,EAAE,SAAS,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;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,uBAAuB;QACtC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,aAAa,CAAC;QAEjD;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;;WAGG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEhC;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;QAE7E;;;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,uBAAuB,CAAC;QACvC,UAAiB,WAAW;YAC1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;;;eAIG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;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,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,yBAAyB,GAAG,MAAM,CAAC,2BAA2B,CAAC;IAE7E;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAE/C;;;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,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,UAAU,CAAC;IAE/C;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,GAAG,qBAAqB,GAAG,UAAU,CAAC;IAE3D;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;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,sBAAsB,CAAC;IACtC,UAAiB,UAAU;QACzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,yBAAiB,OAAO,CAAC;IACvB,MAAM,QAAQ,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACjD,MAAM,QAAQ,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IACnD,MAAM,QAAQ,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;IACjE,MAAM,QAAQ,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAC/D,MAAM,QAAQ,wBAAwB,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAC7E,MAAM,QAAQ,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;IACjE,MAAM,QAAQ,sBAAsB,GAAG,UAAU,CAAC,sBAAsB,CAAC;IACzE,MAAM,QAAQ,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAClC,MAAM,QAAQ,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IACxD,MAAM,QAAQ,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CACzD"}

package/resources/tickets/tickets.js

@@ -0,0 +1,191 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tickets = void 0;
+const resource_1 = require("../../resource.js");
+const core_1 = require("../../core.js");
+const TagsAPI = __importStar(require("./tags.js"));
+class Tickets extends resource_1.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 ((0, core_1.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 ((0, core_1.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,
+            },
+        });
+    }
+}
+exports.Tickets = Tickets;
+(function (Tickets) {
+    Tickets.Tags = TagsAPI.Tags;
+})(Tickets = exports.Tickets || (exports.Tickets = {}));
+//# sourceMappingURL=tickets.js.map