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

package/resources/data-attributes.d.ts

@@ -0,0 +1,198 @@
+import { APIResource } from "../resource.js";
+import * as Core from "../core.js";
+import * as DataAttributesAPI from "./data-attributes.js";
+export declare class DataAttributes extends APIResource {
+    /**
+     * You can create a data attributes for a `contact` or a `company`.
+     */
+    create(params: DataAttributeCreateParams, options?: Core.RequestOptions): Core.APIPromise<DataAttribute>;
+    /**
+     * You can update a data attribute.
+     *
+     * > 🚧 Updating the data type is not possible
+     * >
+     * > It is currently a dangerous action to execute changing a data attribute's type
+     * > via the API. You will need to update the type via the UI instead.
+     */
+    update(id: number, params?: DataAttributeUpdateParams, options?: Core.RequestOptions): Core.APIPromise<DataAttribute>;
+    update(id: number, options?: Core.RequestOptions): Core.APIPromise<DataAttribute>;
+    /**
+     * You can fetch a list of all data attributes belonging to a workspace for
+     * contacts, companies or conversations.
+     */
+    list(params?: DataAttributeListParams, options?: Core.RequestOptions): Core.APIPromise<DataAttributeList>;
+    list(options?: Core.RequestOptions): Core.APIPromise<DataAttributeList>;
+}
+/**
+ * Data Attributes are metadata used to describe your contact, company and
+ * conversation models. These include standard and custom attributes. By using the
+ * data attributes endpoint, you can get the global list of attributes for your
+ * workspace, as well as create and archive custom attributes.
+ */
+export interface DataAttribute {
+    /**
+     * The unique identifier for the data attribute which is given by Intercom. Only
+     * available for custom attributes.
+     */
+    id?: number;
+    /**
+     * Teammate who created the attribute. Only applicable to CDAs
+     */
+    admin_id?: string;
+    /**
+     * Can this attribute be updated through API
+     */
+    api_writable?: boolean;
+    /**
+     * Is this attribute archived. (Only applicable to CDAs)
+     */
+    archived?: boolean;
+    /**
+     * The time the attribute was created as a UTC Unix timestamp
+     */
+    created_at?: number;
+    /**
+     * Set to true if this is a CDA
+     */
+    custom?: boolean;
+    /**
+     * The data type of the attribute.
+     */
+    data_type?: 'string' | 'integer' | 'float' | 'boolean' | 'date';
+    /**
+     * Readable description of the attribute.
+     */
+    description?: string;
+    /**
+     * Full name of the attribute. Should match the name unless it's a nested
+     * attribute. We can split full_name on `.` to access nested user object values.
+     */
+    full_name?: string;
+    /**
+     * Readable name of the attribute (i.e. name you see in the UI)
+     */
+    label?: string;
+    /**
+     * Can this attribute be updated by the Messenger
+     */
+    messenger_writable?: boolean;
+    /**
+     * Value is `contact` for user/lead attributes and `company` for company
+     * attributes.
+     */
+    model?: 'contact' | 'company';
+    /**
+     * Name of the attribute.
+     */
+    name?: string;
+    /**
+     * List of predefined options for attribute value.
+     */
+    options?: Array<string>;
+    /**
+     * Value is `data_attribute`.
+     */
+    type?: 'data_attribute';
+    /**
+     * Can this attribute be updated in the UI
+     */
+    ui_writable?: boolean;
+    /**
+     * The time the attribute was last updated as a UTC Unix timestamp
+     */
+    updated_at?: number;
+}
+/**
+ * A list of all data attributes belonging to a workspace for contacts, companies
+ * or conversations.
+ */
+export interface DataAttributeList {
+    /**
+     * A list of data attributes
+     */
+    data?: Array<DataAttribute>;
+    /**
+     * The type of the object
+     */
+    type?: 'list';
+}
+export interface DataAttributeCreateParams {
+    /**
+     * Body param: The type of data stored for this attribute.
+     */
+    data_type: 'string' | 'integer' | 'float' | 'boolean' | 'datetime' | 'date';
+    /**
+     * Body param: The model that the data attribute belongs to.
+     */
+    model: 'contact' | 'company';
+    /**
+     * Body param: The name of the data attribute.
+     */
+    name: string;
+    /**
+     * Body param: The readable description you see in the UI for the attribute.
+     */
+    description?: string;
+    /**
+     * Body param: Can this attribute be updated by the Messenger
+     */
+    messenger_writable?: boolean;
+    /**
+     * Body param: To create list attributes. Provide a set of hashes with `value` as
+     * the key of the options you want to make. `data_type` must be `string`.
+     */
+    options?: Array<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 interface DataAttributeUpdateParams {
+    /**
+     * Body param: Whether the attribute is to be archived or not.
+     */
+    archived?: boolean;
+    /**
+     * Body param: The readable description you see in the UI for the attribute.
+     */
+    description?: string;
+    /**
+     * Body param: Can this attribute be updated by the Messenger
+     */
+    messenger_writable?: boolean;
+    /**
+     * Body param: To create list attributes. Provide a set of hashes with `value` as
+     * the key of the options you want to make. `data_type` must be `string`.
+     */
+    options?: Array<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 interface DataAttributeListParams {
+    /**
+     * Query param: Include archived attributes in the list. By default we return only
+     * non archived data attributes.
+     */
+    include_archived?: boolean;
+    /**
+     * Query param: Specify the data attribute model to return.
+     */
+    model?: 'contact' | 'company' | 'conversation';
+    /**
+     * 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 DataAttributes {
+    export import DataAttribute = DataAttributesAPI.DataAttribute;
+    export import DataAttributeList = DataAttributesAPI.DataAttributeList;
+    export import DataAttributeCreateParams = DataAttributesAPI.DataAttributeCreateParams;
+    export import DataAttributeUpdateParams = DataAttributesAPI.DataAttributeUpdateParams;
+    export import DataAttributeListParams = DataAttributesAPI.DataAttributeListParams;
+}
+//# sourceMappingURL=data-attributes.d.ts.map

package/resources/data-attributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-attributes.d.ts","sourceRoot":"","sources":["../src/resources/data-attributes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,iBAAiB,MAAM,mBAAmB,CAAC;AAEvD,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;IAcxG;;;;;;;OAOG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;IACjC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;IAsBjF;;;OAGG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;IACzG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAoBxE;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IAEhE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAE9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;IAE5E;;OAEG;IACH,KAAK,EAAE,SAAS,GAAG,SAAS,CAAC;IAE7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;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,yBAAyB;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;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,uBAAuB;IACtC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,cAAc,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,yBAAiB,cAAc,CAAC;IAC9B,MAAM,QAAQ,aAAa,GAAG,iBAAiB,CAAC,aAAa,CAAC;IAC9D,MAAM,QAAQ,iBAAiB,GAAG,iBAAiB,CAAC,iBAAiB,CAAC;IACtE,MAAM,QAAQ,yBAAyB,GAAG,iBAAiB,CAAC,yBAAyB,CAAC;IACtF,MAAM,QAAQ,yBAAyB,GAAG,iBAAiB,CAAC,yBAAyB,CAAC;IACtF,MAAM,QAAQ,uBAAuB,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;CACnF"}

package/resources/data-attributes.js

@@ -0,0 +1,60 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataAttributes = void 0;
+const resource_1 = require("../resource.js");
+const core_1 = require("../core.js");
+class DataAttributes extends resource_1.APIResource {
+    /**
+     * You can create a data attributes for a `contact` or a `company`.
+     */
+    create(params, options) {
+        const { 'Intercom-Version': intercomVersion, ...body } = params;
+        return this._client.post('/data_attributes', {
+            body,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+    update(id, params = {}, options) {
+        if ((0, core_1.isRequestOptions)(params)) {
+            return this.update(id, {}, params);
+        }
+        const { 'Intercom-Version': intercomVersion, ...body } = params;
+        return this._client.put(`/data_attributes/${id}`, {
+            body,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+    list(params = {}, options) {
+        if ((0, core_1.isRequestOptions)(params)) {
+            return this.list({}, params);
+        }
+        const { 'Intercom-Version': intercomVersion, ...query } = params;
+        return this._client.get('/data_attributes', {
+            query,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+}
+exports.DataAttributes = DataAttributes;
+(function (DataAttributes) {
+})(DataAttributes = exports.DataAttributes || (exports.DataAttributes = {}));
+//# sourceMappingURL=data-attributes.js.map

package/resources/data-attributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-attributes.js","sourceRoot":"","sources":["../src/resources/data-attributes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAI3C,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;OAEG;IACH,MAAM,CAAC,MAAiC,EAAE,OAA6B;QACrE,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,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;IAgBD,MAAM,CACJ,EAAU,EACV,SAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SACpC;QACD,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,EAAE;YAChD,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;IAQD,IAAI,CACF,SAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SAC9B;QACD,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE;YAC1C,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;CACF;AA9ED,wCA8EC;AA+PD,WAAiB,cAAc;AAM/B,CAAC,EANgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAM9B"}

package/resources/data-attributes.mjs

@@ -0,0 +1,56 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../resource.mjs";
+import { isRequestOptions } from "../core.mjs";
+export class DataAttributes extends APIResource {
+    /**
+     * You can create a data attributes for a `contact` or a `company`.
+     */
+    create(params, options) {
+        const { 'Intercom-Version': intercomVersion, ...body } = params;
+        return this._client.post('/data_attributes', {
+            body,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+    update(id, params = {}, options) {
+        if (isRequestOptions(params)) {
+            return this.update(id, {}, params);
+        }
+        const { 'Intercom-Version': intercomVersion, ...body } = params;
+        return this._client.put(`/data_attributes/${id}`, {
+            body,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+    list(params = {}, options) {
+        if (isRequestOptions(params)) {
+            return this.list({}, params);
+        }
+        const { 'Intercom-Version': intercomVersion, ...query } = params;
+        return this._client.get('/data_attributes', {
+            query,
+            ...options,
+            headers: {
+                ...(intercomVersion?.toString() != null ?
+                    { 'Intercom-Version': intercomVersion?.toString() }
+                    : undefined),
+                ...options?.headers,
+            },
+        });
+    }
+}
+(function (DataAttributes) {
+})(DataAttributes || (DataAttributes = {}));
+//# sourceMappingURL=data-attributes.mjs.map

package/resources/data-attributes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-attributes.mjs","sourceRoot":"","sources":["../src/resources/data-attributes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAI3B,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;OAEG;IACH,MAAM,CAAC,MAAiC,EAAE,OAA6B;QACrE,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,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;IAgBD,MAAM,CACJ,EAAU,EACV,SAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SACpC;QACD,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,EAAE;YAChD,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;IAQD,IAAI,CACF,SAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SAC9B;QACD,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE;YAC1C,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;CACF;AA+PD,WAAiB,cAAc;AAM/B,CAAC,EANgB,cAAc,KAAd,cAAc,QAM9B"}

package/resources/data-events.d.ts

@@ -0,0 +1,276 @@
+import { APIResource } from "../resource.js";
+import * as Core from "../core.js";
+import * as DataEventsAPI from "./data-events.js";
+export declare class DataEvents extends APIResource {
+    /**
+     * You will need an Access Token that has write permissions to send Events. Once
+     * you have a key you can submit events via POST to the Events resource, which is
+     * located at https://api.intercom.io/events, or you can send events using one of
+     * the client libraries. When working with the HTTP API directly a client should
+     * send the event with a `Content-Type` of `application/json`.
+     *
+     * When using the JavaScript API,
+     * [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app)
+     * makes the Events API available. Once added, you can submit an event using the
+     * `trackEvent` method. This will associate the event with the Lead or currently
+     * logged-in user or logged-out visitor/lead and send it to Intercom. The final
+     * parameter is a map that can be used to send optional metadata about the event.
+     *
+     * With the Ruby client you pass a hash describing the event to
+     * `Intercom::Event.create`, or call the `track_user` method directly on the
+     * current user object (e.g. `user.track_event`).
+     *
+     * **NB: For the JSON object types, please note that we do not currently support
+     * nested JSON structure.**
+     *
+     * | Type            | Description                                                                                                                                                                                                     | Example                                                                           |
+     * | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- |
+     * | String          | The value is a JSON String                                                                                                                                                                                      | `"source":"desktop"`                                                              |
+     * | Number          | The value is a JSON Number                                                                                                                                                                                      | `"load": 3.67`                                                                    |
+     * | Date            | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272`                                                      |
+     * | Link            | The value is a HTTP or HTTPS URI.                                                                                                                                                                               | `"article": "https://example.org/ab1de.html"`                                     |
+     * | Rich Link       | The value is a JSON object that contains `url` and `value` keys.                                                                                                                                                | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` |
+     * | Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99.          | `"price": {"amount": 34999, "currency": "eur"}`                                   |
+     *
+     * **Lead Events**
+     *
+     * When submitting events for Leads, you will need to specify the Lead's `id`.
+     *
+     * **Metadata behaviour**
+     *
+     * - We currently limit the number of tracked metadata keys to 10 per event. Once
+     *   the quota is reached, we ignore any further keys we receive. The first 10
+     *   metadata keys are determined by the order in which they are sent in with the
+     *   event.
+     * - It is not possible to change the metadata keys once the event has been sent. A
+     *   new event will need to be created with the new keys and you can archive the
+     *   old one.
+     * - There might be up to 24 hrs delay when you send a new metadata for an existing
+     *   event.
+     *
+     * **Event de-duplication**
+     *
+     * The API may detect and ignore duplicate events. Each event is uniquely
+     * identified as a combination of the following data - the Workspace identifier,
+     * the Contact external identifier, the Data Event name and the Data Event created
+     * time. As a result, it is **strongly recommended** to send a second granularity
+     * Unix timestamp in the `created_at` field.
+     *
+     * Duplicated events are responded to using the normal `202 Accepted` code - an
+     * error is not thrown, however repeat requests will be counted against any rate
+     * limit that is in place.
+     *
+     * ### HTTP API Responses
+     *
+     * - Successful responses to submitted events return `202 Accepted` with an empty
+     *   body.
+     * - Unauthorised access will be rejected with a `401 Unauthorized` or
+     *   `403 Forbidden` response code.
+     * - Events sent about users that cannot be found will return a `404 Not Found`.
+     * - Event lists containing duplicate events will have those duplicates ignored.
+     * - Server errors will return a `500` response code and may contain an error
+     *   message in the body.
+     */
+    create(params: DataEventCreateParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+    /**
+     * > 🚧
+     * >
+     * > Please note that you can only 'list' events that are less than 90 days old.
+     * > Event counts and summaries will still include your events older than 90 days
+     * > but you cannot 'list' these events individually if they are older than 90 days
+     *
+     * The events belonging to a customer can be listed by sending a GET request to
+     * `https://api.intercom.io/events` with a user or lead identifier along with a
+     * `type` parameter. The identifier parameter can be one of `user_id`, `email` or
+     * `intercom_user_id`. The `type` parameter value must be `user`.
+     *
+     * - `https://api.intercom.io/events?type=user&user_id={user_id}`
+     * - `https://api.intercom.io/events?type=user&email={email}`
+     * - `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call
+     *   can be used to list leads)
+     *
+     * The `email` parameter value should be
+     * [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.
+     *
+     * You can optionally define the result page size as well with the `per_page`
+     * parameter.
+     */
+    list(params: DataEventListParams, options?: Core.RequestOptions): Core.APIPromise<DataEventSummary>;
+    /**
+     * Create event summaries for a user. Event summaries are used to track the number
+     * of times an event has occurred, the first time it occurred and the last time it
+     * occurred.
+     */
+    summaries(params?: DataEventSummariesParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+    summaries(options?: Core.RequestOptions): Core.APIPromise<void>;
+}
+/**
+ * This will return a summary of data events for the App.
+ */
+export interface DataEventSummary {
+    /**
+     * The email address of the user
+     */
+    email?: string;
+    /**
+     * A summary of data events
+     */
+    events?: Array<DataEventSummary.Event | null>;
+    /**
+     * The Intercom user ID of the user
+     */
+    intercom_user_id?: string;
+    /**
+     * The type of the object
+     */
+    type?: 'event.summary';
+    /**
+     * The user ID of the user
+     */
+    user_id?: string;
+}
+export declare namespace DataEventSummary {
+    /**
+     * This will return a summary of a data event for the App.
+     */
+    interface Event {
+        /**
+         * The number of times the event was sent
+         */
+        count?: number;
+        /**
+         * The description of the event
+         */
+        description?: string;
+        /**
+         * The first time the event was sent
+         */
+        first?: string;
+        /**
+         * The last time the event was sent
+         */
+        last?: string;
+        /**
+         * The name of the event
+         */
+        name?: string;
+    }
+}
+export type DataEventCreateParams = DataEventCreateParams.IDRequired | DataEventCreateParams.UserIDRequired | DataEventCreateParams.EmailRequired;
+export declare namespace DataEventCreateParams {
+    interface IDRequired {
+        /**
+         * 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 UserIDRequired {
+        /**
+         * 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 EmailRequired {
+        /**
+         * 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 DataEventListParams {
+    /**
+     * Query param:
+     */
+    filter: DataEventListParams.UserIDQueryParameter | DataEventListParams.IntercomUserIDQueryParameter | DataEventListParams.EmailQueryParameter;
+    /**
+     * Query param: The value must be user
+     */
+    type: string;
+    /**
+     * Query param: summary flag
+     */
+    summary?: boolean;
+    /**
+     * 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 DataEventListParams {
+    interface UserIDQueryParameter {
+        user_id: string;
+    }
+    interface IntercomUserIDQueryParameter {
+        intercom_user_id: string;
+    }
+    interface EmailQueryParameter {
+        email: string;
+    }
+}
+export interface DataEventSummariesParams {
+    /**
+     * Body param: A list of event summaries for the user. Each event summary should
+     * contain the event name, the time the event occurred, and the number of times the
+     * event occurred. The event name should be a past tense 'verb-noun' combination,
+     * to improve readability, for example `updated-plan`.
+     */
+    event_summaries?: DataEventSummariesParams.EventSummaries;
+    /**
+     * Body param: Your identifier for the user.
+     */
+    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 declare namespace DataEventSummariesParams {
+    /**
+     * A list of event summaries for the user. Each event summary should contain the
+     * event name, the time the event occurred, and the number of times the event
+     * occurred. The event name should be a past tense 'verb-noun' combination, to
+     * improve readability, for example `updated-plan`.
+     */
+    interface EventSummaries {
+        /**
+         * The number of times the event occurred.
+         */
+        count?: number;
+        /**
+         * The name of the event that occurred. A good event name is typically a past tense
+         * 'verb-noun' combination, to improve readability, for example `updated-plan`.
+         */
+        event_name?: string;
+        /**
+         * The first time the event was sent
+         */
+        first?: number;
+        /**
+         * The last time the event was sent
+         */
+        last?: number;
+    }
+}
+export declare namespace DataEvents {
+    export import DataEventSummary = DataEventsAPI.DataEventSummary;
+    export import DataEventCreateParams = DataEventsAPI.DataEventCreateParams;
+    export import DataEventListParams = DataEventsAPI.DataEventListParams;
+    export import DataEventSummariesParams = DataEventsAPI.DataEventSummariesParams;
+}
+//# sourceMappingURL=data-events.d.ts.map

package/resources/data-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-events.d.ts","sourceRoot":"","sources":["../src/resources/data-events.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,aAAa,MAAM,eAAe,CAAC;AAE/C,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEG;IACH,MAAM,CAAC,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAe3F;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAcnG;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAClG,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAqBhE;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAE9C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,MAAM,qBAAqB,GAC7B,qBAAqB,CAAC,UAAU,GAChC,qBAAqB,CAAC,cAAc,GACpC,qBAAqB,CAAC,aAAa,CAAC;AAExC,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,UAAU;QACzB;;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,cAAc;QAC7B;;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,aAAa;QAC5B;;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,mBAAmB;IAClC;;OAEG;IACH,MAAM,EACF,mBAAmB,CAAC,oBAAoB,GACxC,mBAAmB,CAAC,4BAA4B,GAChD,mBAAmB,CAAC,mBAAmB,CAAC;IAE5C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;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,mBAAmB,CAAC;IACnC,UAAiB,oBAAoB;QACnC,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,UAAiB,4BAA4B;QAC3C,gBAAgB,EAAE,MAAM,CAAC;KAC1B;IAED,UAAiB,mBAAmB;QAClC,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,eAAe,CAAC,EAAE,wBAAwB,CAAC,cAAc,CAAC;IAE1D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;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,wBAAwB,CAAC;IACxC;;;;;OAKG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,yBAAiB,UAAU,CAAC;IAC1B,MAAM,QAAQ,gBAAgB,GAAG,aAAa,CAAC,gBAAgB,CAAC;IAChE,MAAM,QAAQ,qBAAqB,GAAG,aAAa,CAAC,qBAAqB,CAAC;IAC1E,MAAM,QAAQ,mBAAmB,GAAG,aAAa,CAAC,mBAAmB,CAAC;IACtE,MAAM,QAAQ,wBAAwB,GAAG,aAAa,CAAC,wBAAwB,CAAC;CACjF"}