Skip to content

Commit d02f055

Browse files
VoloVolo
authored andcommitted
Add Events & Data Attributes sections
1 parent 6f7efc9 commit d02f055

File tree

1 file changed

+55
-2
lines changed

1 file changed

+55
-2
lines changed

README.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -678,18 +678,71 @@ const response = await client.conversations.redactConversationPart({
678678

679679
### Data Attributes
680680

681-
#### Placeholder
681+
#### [Create Data Attribute](https://developers.intercom.com/intercom-api-reference/reference/create-data-attributes)
682682

683683
```typescript
684+
const response = await client.dataAttributes.create({
685+
name: 'list_cda',
686+
model: ModelType.CONTACT,
687+
dataType: DataType.STRING,
688+
description: 'You are either alive or dead',
689+
options: [{ value: 'alive' }, { value: 'dead' }],
690+
});
691+
```
684692

693+
#### [Update Data Attribute](https://developers.intercom.com/intercom-api-reference/reference/update-data-attributes)
694+
695+
```typescript
696+
const response = await client.dataAttributes.update({
697+
id: '123',
698+
description: 'You are either alive or dead',
699+
options: [{ value: 'alive' }, { value: 'dead' }],
700+
archived: true,
701+
});
702+
```
703+
704+
#### [List all Data Attributes](https://developers.intercom.com/intercom-api-reference/reference/list-data-attributes)
705+
706+
```typescript
707+
const response = await client.dataAttributes.list({
708+
model: ModelType.CONTACT,
709+
includeArchived: true,
710+
});
685711
```
686712

687713
### Events
688714

689-
#### Placeholder
715+
#### [Submit a data event](https://developers.intercom.com/intercom-api-reference/reference/list-data-attributes)
690716

691717
```typescript
718+
const response = await client.events.create({
719+
eventName: 'placed-order',
720+
createdAt: 1389913941,
721+
userId: 'f4ca124298',
722+
metadata: {
723+
order_date: 1392036272,
724+
stripe_invoice: 'inv_3434343434',
725+
order_number: {
726+
value: '3434-3434',
727+
url: 'https://example.org/orders/3434-3434',
728+
},
729+
price: {
730+
currency: 'usd',
731+
amount: 2999,
732+
},
733+
},
734+
});
735+
```
736+
737+
#### [List all data events](https://developers.intercom.com/intercom-api-reference/reference/list-user-events)
692738

739+
```typescript
740+
const response = await client.events.listBy({
741+
userId: '1234',
742+
perPage: 2,
743+
summary: true,
744+
745+
});
693746
```
694747

695748
### Segments

0 commit comments

Comments
 (0)