# Shared Types
```python
from python_intercom.types import (
Admin,
ArticleContent,
ArticleTranslatedContent,
Company,
Contact,
ContactReference,
Conversation,
CursorPages,
GroupContent,
GroupTranslatedContent,
Message,
MultipleFilterSearchRequest,
Note,
PartAttachment,
Reference,
SearchRequest,
SingleFilterSearchRequest,
StartingAfterPaging,
SubscriptionTypeList,
Tag,
TagList,
Ticket,
TicketTypeAttribute,
)
```
# Me
Types:
```python
from python_intercom.types import AdminWithApp
```
Methods:
- client.me.retrieve() -> Optional
# Admins
Types:
```python
from python_intercom.types import AdminList
```
Methods:
- client.admins.retrieve(id) -> Optional
- client.admins.list() -> AdminList
- client.admins.set_away(id, \*\*params) -> Optional
## ActivityLogs
Types:
```python
from python_intercom.types.admins import ActivityLogList
```
Methods:
- client.admins.activity_logs.list(\*\*params) -> ActivityLogList
# Articles
Types:
```python
from python_intercom.types import Article, ArticleList, ArticleSearchResponse, DeletedArticleObject
```
Methods:
- client.articles.create(\*\*params) -> Article
- client.articles.retrieve(id) -> Article
- client.articles.update(id, \*\*params) -> Article
- client.articles.list() -> ArticleList
- client.articles.remove(id) -> DeletedArticleObject
- client.articles.search(\*\*params) -> ArticleSearchResponse
# HelpCenter
Types:
```python
from python_intercom.types import HelpCenter, HelpCenterList
```
## Collections
Types:
```python
from python_intercom.types.help_center import Collection, CollectionList, DeletedCollection
```
Methods:
- client.help_center.collections.create(\*\*params) -> Collection
- client.help_center.collections.retrieve(id) -> Collection
- client.help_center.collections.update(id, \*\*params) -> Collection
- client.help_center.collections.list() -> CollectionList
- client.help_center.collections.delete(id) -> DeletedCollection
## HelpCenters
Methods:
- client.help_center.help_centers.retrieve(id) -> HelpCenter
- client.help_center.help_centers.list() -> HelpCenterList
# Companies
Types:
```python
from python_intercom.types import CompanyList, CompanyScroll, DeletedCompanyObject
```
Methods:
- client.companies.create(\*\*params) -> Company
- client.companies.retrieve(id) -> Company
- client.companies.update(id) -> Company
- client.companies.list(\*\*params) -> CompanyList
- client.companies.delete(id) -> DeletedCompanyObject
- client.companies.retrieve_list(\*\*params) -> CompanyList
- client.companies.scroll(\*\*params) -> Optional
## Contacts
Types:
```python
from python_intercom.types.companies import CompanyAttachedContacts
```
Methods:
- client.companies.contacts.list(id) -> CompanyAttachedContacts
## Segments
Types:
```python
from python_intercom.types.companies import CompanyAttachedSegments
```
Methods:
- client.companies.segments.list(id) -> CompanyAttachedSegments
# Contacts
Types:
```python
from python_intercom.types import ContactArchived, ContactDeleted, ContactList, ContactUnarchived
```
Methods:
- client.contacts.create(\*\*params) -> Contact
- client.contacts.retrieve(id) -> Contact
- client.contacts.update(id, \*\*params) -> Contact
- client.contacts.list() -> ContactList
- client.contacts.delete(id) -> ContactDeleted
- client.contacts.archive(id) -> ContactArchived
- client.contacts.merge(\*\*params) -> Contact
- client.contacts.search(\*\*params) -> ContactList
- client.contacts.unarchive(id) -> ContactUnarchived
## Companies
Types:
```python
from python_intercom.types.contacts import ContactAttachedCompanies
```
Methods:
- client.contacts.companies.create(contact_id, \*\*params) -> Company
- client.contacts.companies.list(contact_id) -> ContactAttachedCompanies
- client.contacts.companies.delete(id, \*, contact_id) -> Company
## Notes
Types:
```python
from python_intercom.types.contacts import NoteList
```
Methods:
- client.contacts.notes.create(id, \*\*params) -> Note
- client.contacts.notes.list(id) -> NoteList
## Segments
Types:
```python
from python_intercom.types.contacts import ContactSegments
```
Methods:
- client.contacts.segments.list(contact_id) -> ContactSegments
## Subscriptions
Types:
```python
from python_intercom.types.contacts import SubscriptionType
```
Methods:
- client.contacts.subscriptions.create(contact_id, \*\*params) -> SubscriptionType
- client.contacts.subscriptions.list(contact_id) -> SubscriptionTypeList
- client.contacts.subscriptions.delete(id, \*, contact_id) -> SubscriptionType
## Tags
Methods:
- client.contacts.tags.create(contact_id, \*\*params) -> Tag
- client.contacts.tags.list(contact_id) -> TagList
- client.contacts.tags.delete(id, \*, contact_id) -> Tag
# Conversations
Types:
```python
from python_intercom.types import ConversationListResponse, ConversationSearchResponse
```
Methods:
- client.conversations.create(\*\*params) -> Message
- client.conversations.retrieve(id, \*\*params) -> Conversation
- client.conversations.update(id, \*\*params) -> Conversation
- client.conversations.list(\*\*params) -> SyncCursorPagination[ConversationListResponse]
- client.conversations.convert(id, \*\*params) -> Optional
- client.conversations.redact(\*\*params) -> Conversation
- client.conversations.search(\*\*params) -> ConversationSearchResponse
## Tags
Methods:
- client.conversations.tags.create(conversation_id, \*\*params) -> Tag
- client.conversations.tags.delete(id, \*, conversation_id, \*\*params) -> Tag
## Reply
Methods:
- client.conversations.reply.create(id, \*\*params) -> Conversation
## Parts
Methods:
- client.conversations.parts.create(id, \*\*params) -> Conversation
## RunAssignmentRules
Methods:
- client.conversations.run_assignment_rules.create(id) -> Conversation
## Customers
Methods:
- client.conversations.customers.create(id, \*\*params) -> Conversation
- client.conversations.customers.delete(contact_id, \*, conversation_id, \*\*params) -> Conversation
# DataAttributes
Types:
```python
from python_intercom.types import DataAttribute, DataAttributeList
```
Methods:
- client.data_attributes.create(\*\*params) -> DataAttribute
- client.data_attributes.update(id, \*\*params) -> DataAttribute
- client.data_attributes.list(\*\*params) -> DataAttributeList
# DataEvents
Types:
```python
from python_intercom.types import DataEventSummary
```
Methods:
- client.data_events.create(\*\*params) -> None
- client.data_events.list(\*\*params) -> DataEventSummary
- client.data_events.summaries(\*\*params) -> None
# DataExports
Types:
```python
from python_intercom.types import DataExport
```
Methods:
- client.data_exports.content_data(\*\*params) -> DataExport
# Export
Methods:
- client.export.cancel(job_identifier) -> DataExport
## Content
### Data
Methods:
- client.export.content.data.retrieve(job_identifier) -> DataExport
# Download
## Content
### Data
Methods:
- client.download.content.data.retrieve(job_identifier) -> None
# Messages
Methods:
- client.messages.create(\*\*params) -> Message
# News
## NewsItems
Types:
```python
from python_intercom.types.news import NewsItem, NewsItemListResponse, NewsItemDeleteResponse
```
Methods:
- client.news.news_items.create(\*\*params) -> NewsItem
- client.news.news_items.retrieve(id) -> NewsItem
- client.news.news_items.update(id, \*\*params) -> NewsItem
- client.news.news_items.list() -> NewsItemListResponse
- client.news.news_items.delete(id) -> NewsItemDeleteResponse
## Newsfeeds
Types:
```python
from python_intercom.types.news import Newsfeed, NewsfeedListResponse
```
Methods:
- client.news.newsfeeds.retrieve(id) -> Newsfeed
- client.news.newsfeeds.list() -> NewsfeedListResponse
### Items
Types:
```python
from python_intercom.types.news.newsfeeds import ItemListResponse
```
Methods:
- client.news.newsfeeds.items.list(id) -> ItemListResponse
# Notes
Methods:
- client.notes.retrieve(id) -> Note
# Segments
Types:
```python
from python_intercom.types import Segment, SegmentList
```
Methods:
- client.segments.retrieve(id) -> Segment
- client.segments.list(\*\*params) -> SegmentList
# SubscriptionTypes
Methods:
- client.subscription_types.list() -> SubscriptionTypeList
# PhoneCallRedirects
Types:
```python
from python_intercom.types import PhoneSwitch
```
Methods:
- client.phone_call_redirects.create(\*\*params) -> Optional
# Tags
Methods:
- client.tags.retrieve(id) -> Tag
- client.tags.list() -> TagList
- client.tags.delete(id) -> None
- client.tags.create_or_update(\*\*params) -> Tag
# Teams
Types:
```python
from python_intercom.types import Team, TeamList
```
Methods:
- client.teams.retrieve(id) -> Team
- client.teams.list() -> TeamList
# TicketTypes
Types:
```python
from python_intercom.types import TicketType, TicketTypeList
```
Methods:
- client.ticket_types.create(\*\*params) -> Optional
- client.ticket_types.retrieve(id) -> Optional
- client.ticket_types.update(id, \*\*params) -> Optional
- client.ticket_types.list() -> TicketTypeList
## Attributes
Methods:
- client.ticket_types.attributes.create(ticket_type_id, \*\*params) -> Optional
- client.ticket_types.attributes.update(id, \*, ticket_type_id, \*\*params) -> Optional
# Tickets
Types:
```python
from python_intercom.types import TicketList, TicketReply
```
Methods:
- client.tickets.create(\*\*params) -> Optional
- client.tickets.reply(id, \*\*params) -> TicketReply
- client.tickets.retrieve_by_id(id) -> Optional
- client.tickets.search(\*\*params) -> TicketList
- client.tickets.update_by_id(id, \*\*params) -> Optional
## Tags
Methods:
- client.tickets.tags.create(ticket_id, \*\*params) -> Tag
- client.tickets.tags.remove(id, \*, ticket_id, \*\*params) -> Tag
# Visitors
Types:
```python
from python_intercom.types import Visitor, VisitorDeletedObject
```
Methods:
- client.visitors.retrieve(\*\*params) -> Optional
- client.visitors.update(\*\*params) -> Optional
- client.visitors.convert(\*\*params) -> Contact