client.articles.list(...)client.ai_content.list_content_import_sources()client.articles.create(...)client.ai_content.create_content_import_source(...)client.articles.find(...)client.ai_content.get_content_import_source(...)client.articles.update(...)client.ai_content.update_content_import_source(...)New gifts in store for the jolly season
", +client.ai_content.update_content_import_source( + source_id="source_id", + sync_behavior="api", + url="https://www.example.com", ) ``` @@ -700,7 +617,7 @@ client.articles.update(client.ai_content.delete_content_import_source(...)client.articles.delete(...)client.ai_content.list_external_pages()client.articles.search(...)client.ai_content.create_external_page(...)client.help_centers.find(...)client.ai_content.get_external_page(...)client.help_centers.list(...)client.ai_content.update_external_page(...)client.companies.retrieve(...)client.companies.create_or_update(...)client.ai_content.delete_external_page(...)client.articles.list(...)client.companies.find(...)client.articles.create(...)client.companies.update(...)client.articles.find(...)client.companies.delete(...)client.articles.update(...)New gifts in store for the jolly season
", ) ``` @@ -1559,7 +1460,7 @@ client.companies.delete(client.companies.list_attached_contacts(...)client.companies.list_attached_segments(...)client.articles.delete(...)client.companies.list(...)client.articles.search(...)client.companies.scroll(...)client.away_status_reasons.list_away_status_reasons()client.companies.attach_contact(...)client.export.enqueue_a_new_reporting_data_export_job(...)client.companies.detach_contact(...)client.export.list_available_datasets_and_attributes()client.data_export.export_reporting_data(...)client.contacts.list_attached_companies(...)client.data_export.download_reporting_data_export(...)client.contacts.list_attached_segments(...)client.data_export.create(...)client.contacts.list_attached_subscriptions(...)client.data_export.find(...)client.contacts.attach_subscription(...)client.data_export.cancel(...)client.data_export.download(...)client.contacts.detach_subscription(...)client.help_centers.find(...)client.contacts.list_attached_tags(...)client.help_centers.list(...)client.contacts.find(...)client.internal_articles.list_internal_articles()client.contacts.update(...)client.internal_articles.create_internal_article(...)client.internal_articles.retrieve_internal_article(...)client.internal_articles.update_internal_article(...)New gifts in store for the jolly season
", +) + +``` +client.contacts.delete(...)client.internal_articles.delete_internal_article(...)client.contacts.merge_lead_in_user(...)client.internal_articles.search_internal_articles(...)client.contacts.search(...)client.companies.retrieve(...)client.contacts.list(...)client.companies.create_or_update(...)client.contacts.create(...)client.companies.find(...)client.contacts.archive(...)client.companies.update(...)client.contacts.unarchive(...)client.companies.delete(...)client.notes.list(...)client.companies.list_attached_contacts(...)client.notes.create(...)client.companies.list_attached_segments(...)client.notes.find(...)client.companies.list(...)client.tags.tag_contact(...)client.companies.scroll(...)client.tags.untag_contact(...)client.companies.attach_contact(...)client.tags.tag_conversation(...)client.companies.detach_contact(...)client.tags.untag_conversation(...)client.contacts.list_attached_companies(...)client.tags.list()client.contacts.list_attached_segments(...)client.tags.create(...)client.contacts.list_attached_subscriptions(...)client.tags.find(...)client.contacts.attach_subscription(...)client.tags.delete(...)client.contacts.detach_subscription(...)client.tags.tag_ticket(...)client.contacts.list_attached_tags(...)client.tags.untag_ticket(...)client.contacts.find(...)client.conversations.list(...)client.contacts.update(...)client.conversations.create(...)client.conversations.find(...)client.contacts.delete(...)client.conversations.update(...)client.contacts.merge_lead_in_user(...)client.conversations.search(...)client.contacts.search(...)client.conversations.reply(...)client.contacts.list(...)client.conversations.manage(...)client.contacts.create(...)client.conversations.run_assignment_rules(...)client.contacts.show_contact_by_external_id(...)client.conversations.attach_contact_as_admin(...)client.contacts.archive(...)client.conversations.detach_contact_as_admin(...)client.contacts.unarchive(...)client.conversations.redact_conversation_part(...)client.contacts.block_contact(...)client.conversations.convert_to_ticket(...)client.notes.list(...)client.data_attributes.list(...)client.notes.create(...)client.data_attributes.create(...)client.notes.find(...)client.tags.tag_contact(...)client.data_attributes.update(...)client.tags.untag_contact(...)client.events.list(...)client.tags.tag_conversation(...)client.tags.untag_conversation(...)client.events.create(...)client.events.summaries(...)client.tags.list()client.data_export.create(...)client.tags.create(...)client.data_export.find(...)client.tags.find(...)client.data_export.cancel(...)client.tags.delete(...)client.data_export.download(...)client.tags.tag_ticket(...)client.messages.create(...)client.tags.untag_ticket(...)client.segments.list(...)client.conversations.list(...)client.segments.find(...)client.conversations.create(...)client.subscription_types.list()client.phone_call_redirects.create(...)client.conversations.find(...)client.teams.list()client.conversations.update(...)client.teams.find(...)client.ticket_types.list()client.conversations.delete_conversation(...)client.ticket_types.create(...)client.conversations.search(...)client.ticket_types.get(...)client.conversations.reply(...)client.ticket_types.update(...)client.conversations.manage(...)client.tickets.reply(...)client.conversations.attach_contact_as_admin(...)client.tickets.create(...)client.conversations.detach_contact_as_admin(...)client.tickets.get(...)client.conversations.redact_conversation_part(...)client.tickets.update(...)client.conversations.convert_to_ticket(...)client.conversations.run_assignment_rules(...)client.tickets.search(...)client.custom_channel_events.notify_new_conversation(...)client.visitors.find(...)client.custom_channel_events.notify_new_message(...)client.visitors.update(...)client.custom_channel_events.notify_quick_reply_selected(...)client.visitors.merge_to_contact(...)client.custom_channel_events.notify_attribute_collected(...)client.help_centers.collections.list(...)client.custom_object_instances.get_custom_object_instances_by_external_id(...)client.help_centers.collections.create(...)client.custom_object_instances.create_custom_object_instances(...)client.help_centers.collections.find(...)client.custom_object_instances.delete_custom_object_instances_by_id(...)client.help_centers.collections.update(...)client.custom_object_instances.get_custom_object_instances_by_id(...)client.help_centers.collections.delete(...)client.custom_object_instances.delete_custom_object_instances_by_external_id(...)client.news.items.list()client.data_attributes.list(...)client.news.items.create(...)client.data_attributes.create(...)New costumes in store for this spooky season
", - sender_id=991267734, - state="live", - deliver_silently=True, - labels=["Product", "Update", "New"], - reactions=["😆", "😅"], - newsfeed_assignments=[ - NewsfeedAssignment( - newsfeed_id=53, - published_at=1664638214, - ) - ], +client.data_attributes.create( + request=CreateDataAttributeRequestOptions( + options=[ + CreateDataAttributeRequestOptionsOptionsItem( + value="1-10", + ) + ], + ), ) ``` @@ -8824,7 +8637,7 @@ client.news.items.create(client.news.items.find(...)client.data_attributes.update(...)client.news.items.update(...)client.events.list(...)New gifts in store for the jolly season
", - sender_id=991267748, - reactions=["😝", "😂"], -) +> 🚧 +> +> 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.client.news.items.delete(...)client.events.create(...)client.news.feeds.list_items(...)client.events.summaries(...)client.news.feeds.list()client.jobs.status(...)client.news.feeds.find(...)client.messages.create(...)client.ticket_types.attributes.create(...)client.segments.list(...)client.segments.find(...)client.ticket_types.attributes.update(...)client.subscription_types.list()client.phone_call_redirects.create(...)client.unstable.admins.identify_admin()client.calls.list_calls(...)client.unstable.admins.set_away_admin(...)client.calls.show_call(...)client.unstable.admins.list_activity_logs(...)client.calls.show_call_recording(...)client.unstable.admins.list_admins()client.calls.show_call_transcript(...)client.unstable.admins.retrieve_admin(...)client.calls.list_calls_with_transcripts(...)client.unstable.ai_content.list_content_import_sources()client.teams.list()client.unstable.ai_content.create_content_import_source(...)client.teams.find(...)client.unstable.ai_content.get_content_import_source(...)client.ticket_states.list_ticket_states()client.unstable.ai_content.update_content_import_source(...)client.ticket_types.list()client.unstable.ai_content.delete_content_import_source(...)client.ticket_types.create(...)client.unstable.ai_content.list_external_pages()client.ticket_types.get(...)client.unstable.ai_content.create_external_page(...)client.ticket_types.update(...)client.unstable.ai_content.get_external_page(...)client.tickets.reply(...)client.unstable.ai_content.update_external_page(...)client.tickets.create(...)client.unstable.ai_content.delete_external_page(...)client.tickets.enqueue_create_ticket(...)client.unstable.articles.list_articles()client.unstable.articles.create_article(...)client.tickets.get(...)client.unstable.articles.retrieve_article(...)client.tickets.update(...)client.unstable.articles.delete_article(...)client.unstable.articles.search_articles(...)client.tickets.delete_ticket(...)client.unstable.away_status_reasons.list_away_status_reasons()client.tickets.search(...)client.unstable.export.enqueue_a_new_reporting_data_export_job(...)client.visitors.find(...)client.visitors.update(...)client.unstable.export.list_available_datasets_and_attributes()client.visitors.merge_to_contact(...)client.unstable.help_center.list_all_collections()client.help_centers.collections.list(...)client.unstable.help_center.create_collection(...)client.help_centers.collections.create(...)client.unstable.help_center.retrieve_collection(...)client.help_centers.collections.find(...)client.unstable.help_center.update_collection(...)client.help_centers.collections.update(...)client.unstable.help_center.delete_collection(...)client.help_centers.collections.delete(...)client.unstable.help_center.retrieve_help_center(...)client.news.items.list()client.unstable.help_center.list_help_centers()client.news.items.create(...)New costumes in store for this spooky season
", + sender_id=991267834, + state="live", + deliver_silently=True, + labels=["Product", "Update", "New"], + reactions=["😆", "😅"], + newsfeed_assignments=[ + NewsfeedAssignment( + newsfeed_id=53, + published_at=1664638214, + ) + ], +) ``` @@ -11948,83 +11968,23 @@ client.unstable.help_center.list_help_centers()client.unstable.companies.retrieve_company(...)client.unstable.companies.create_or_update_company(...)client.news.items.find(...)client.unstable.companies.retrieve_a_company_by_id(...)client.news.items.update(...)New gifts in store for the jolly season
", + sender_id=991267848, + reactions=["😝", "😂"], +) + +```client.unstable.companies.update_company(...)client.news.items.delete(...)client.unstable.companies.delete_company(...)client.news.feeds.list_items(...)client.unstable.companies.list_attached_contacts(...)client.news.feeds.list()client.unstable.companies.list_attached_segments_for_companies(...)client.news.feeds.find(...)client.unstable.companies.list_all_companies(...)client.ticket_types.attributes.create(...)client.unstable.companies.scroll_over_all_companies(...)client.unstable.companies.attach_contact_to_a_company(...)client.ticket_types.attributes.update(...)client.unstable.companies.detach_contact_from_a_company(...)client.unstable.contacts.list_companies_for_a_contact(...)client.unstable.admins.identify_admin()client.unstable.contacts.list_segments_for_a_contact(...)client.unstable.admins.set_away_admin(...)client.unstable.contacts.list_subscriptions_for_a_contact(...)client.unstable.admins.list_activity_logs(...)client.unstable.contacts.list_tags_for_a_contact(...)client.unstable.admins.list_admins()client.unstable.contacts.show_contact(...)client.unstable.admins.retrieve_admin(...)client.unstable.contacts.update_contact(...)client.unstable.ai_content.list_content_import_sources()client.unstable.ai_content.create_content_import_source(...)client.unstable.contacts.delete_contact(...)client.unstable.ai_content.get_content_import_source(...)client.unstable.contacts.merge_contact(...)client.unstable.ai_content.update_content_import_source(...)client.unstable.contacts.search_contacts(...)client.unstable.ai_content.delete_content_import_source(...)client.unstable.contacts.list_contacts()client.unstable.ai_content.list_external_pages()client.unstable.contacts.create_contact(...)client.unstable.ai_content.create_external_page(...)client.unstable.contacts.show_contact_by_external_id(...)client.unstable.ai_content.get_external_page(...)client.unstable.contacts.archive_contact(...)client.unstable.ai_content.update_external_page(...)client.unstable.contacts.unarchive_contact(...)client.unstable.ai_content.delete_external_page(...)client.unstable.contacts.block_contact(...)client.unstable.articles.list_articles()client.unstable.notes.list_notes(...)client.unstable.articles.create_article(...)client.unstable.notes.create_note(...)client.unstable.articles.retrieve_article(...)client.unstable.notes.retrieve_note(...)client.unstable.articles.delete_article(...)client.unstable.subscription_types.attach_subscription_type_to_contact(...)client.unstable.articles.search_articles(...)client.unstable.subscription_types.detach_subscription_type_to_contact(...)client.unstable.away_status_reasons.list_away_status_reasons()client.unstable.export.enqueue_a_new_reporting_data_export_job(...)client.unstable.subscription_types.list_subscription_types()client.unstable.export.list_available_datasets_and_attributes()client.unstable.tags.attach_tag_to_contact(...)client.unstable.help_center.list_all_collections()client.unstable.tags.detach_tag_from_contact(...)client.unstable.help_center.create_collection(...)client.unstable.tags.attach_tag_to_conversation(...)client.unstable.help_center.retrieve_collection(...)client.unstable.tags.detach_tag_from_conversation(...)client.unstable.help_center.update_collection(...)client.unstable.tags.list_tags()client.unstable.help_center.delete_collection(...)client.unstable.tags.create_tag(...)client.unstable.help_center.retrieve_help_center(...)client.unstable.tags.find_tag(...)client.unstable.help_center.list_help_centers()client.unstable.tags.delete_tag(...)client.unstable.internal_articles.list_internal_articles()client.unstable.tags.attach_tag_to_ticket(...)client.unstable.internal_articles.create_internal_article(...)client.unstable.tags.detach_tag_from_ticket(...)client.unstable.internal_articles.retrieve_internal_article(...)client.unstable.conversations.list_conversations(...)client.unstable.internal_articles.update_internal_article(...)New gifts in store for the jolly season
", +) ``` @@ -15461,7 +15360,7 @@ client.unstable.conversations.list_conversations()client.unstable.conversations.create_conversation(...)client.unstable.internal_articles.delete_internal_article(...)client.unstable.conversations.retrieve_conversation(...)client.unstable.internal_articles.search_internal_articles(...)client.unstable.conversations.update_conversation(...)client.unstable.companies.retrieve_company(...)client.unstable.conversations.delete_conversation(...)client.unstable.companies.create_or_update_company(...)client.unstable.conversations.search_conversations(...)client.unstable.companies.retrieve_a_company_by_id(...)client.unstable.companies.update_company(...)client.unstable.companies.delete_company(...)client.unstable.companies.list_attached_contacts(...)client.unstable.companies.list_attached_segments_for_companies(...)client.unstable.companies.list_all_companies(...)client.unstable.companies.scroll_over_all_companies(...)client.unstable.companies.attach_contact_to_a_company(...)client.unstable.companies.detach_contact_from_a_company(...)client.unstable.contacts.list_companies_for_a_contact(...)client.unstable.contacts.list_segments_for_a_contact(...)client.unstable.contacts.list_subscriptions_for_a_contact(...)client.unstable.contacts.list_tags_for_a_contact(...)client.unstable.contacts.show_contact(...)client.unstable.contacts.update_contact(...)client.unstable.contacts.delete_contact(...)client.unstable.contacts.merge_contact(...)client.unstable.contacts.search_contacts(...)client.unstable.contacts.list_contacts()client.unstable.contacts.create_contact(...)client.unstable.contacts.show_contact_by_external_id(...)client.unstable.contacts.archive_contact(...)client.unstable.contacts.unarchive_contact(...)client.unstable.contacts.block_contact(...)client.unstable.notes.list_notes(...)client.unstable.notes.create_note(...)client.unstable.notes.retrieve_note(...)client.unstable.subscription_types.attach_subscription_type_to_contact(...)client.unstable.subscription_types.detach_subscription_type_to_contact(...)client.unstable.subscription_types.list_subscription_types()client.unstable.tags.attach_tag_to_contact(...)client.unstable.tags.detach_tag_from_contact(...)client.unstable.tags.attach_tag_to_conversation(...)client.unstable.tags.detach_tag_from_conversation(...)client.unstable.tags.list_tags()client.unstable.tags.create_tag(...)client.unstable.tags.find_tag(...)client.unstable.tags.delete_tag(...)client.unstable.tags.attach_tag_to_ticket(...)client.unstable.tags.detach_tag_from_ticket(...)client.unstable.conversations.list_conversations(...)client.unstable.conversations.create_conversation(...)client.unstable.conversations.retrieve_conversation(...)client.unstable.conversations.update_conversation(...)client.unstable.conversations.delete_conversation(...)client.unstable.conversations.search_conversations(...)client.unstable.conversations.reply_conversation(...)client.unstable.conversations.manage_conversation(...)client.unstable.conversations.attach_contact_to_conversation(...)client.unstable.conversations.detach_contact_from_conversation(...)client.unstable.conversations.redact_conversation(...)client.unstable.conversations.convert_conversation_to_ticket(...)client.unstable.custom_channel_events.notify_new_conversation(...)client.unstable.custom_channel_events.notify_new_message(...)client.unstable.conversations.reply_conversation(...)client.unstable.custom_channel_events.notify_quick_reply_selected(...)client.unstable.conversations.manage_conversation(...)client.unstable.custom_channel_events.notify_attribute_collected(...)client.unstable.conversations.attach_contact_to_conversation(...)client.unstable.custom_object_instances.get_custom_object_instances_by_external_id(...)client.unstable.conversations.detach_contact_from_conversation(...)client.unstable.custom_object_instances.create_custom_object_instances(...)client.unstable.conversations.redact_conversation(...)client.unstable.custom_object_instances.delete_custom_object_instances_by_id(...)client.unstable.conversations.convert_conversation_to_ticket(...)client.unstable.custom_object_instances.get_custom_object_instances_by_id(...)client.unstable.custom_channel_events.notify_new_conversation(...)client.unstable.custom_object_instances.delete_custom_object_instances_by_external_id(...)client.unstable.custom_channel_events.notify_new_message(...)client.unstable.data_attributes.lis_data_attributes(...)client.unstable.custom_channel_events.notify_quick_reply_selected(...)client.unstable.data_attributes.create_data_attribute(...)client.unstable.custom_channel_events.notify_attribute_collected(...)client.unstable.data_attributes.update_data_attribute(...)client.unstable.custom_object_instances.get_custom_object_instances_by_external_id(...)client.unstable.data_events.lis_data_events(...)client.unstable.custom_object_instances.create_custom_object_instances(...)client.unstable.data_events.create_data_event(...)client.unstable.custom_object_instances.delete_custom_object_instances_by_id(...)client.unstable.data_events.data_event_summaries(...)client.unstable.custom_object_instances.get_custom_object_instances_by_id(...)client.unstable.data_export.create_data_export(...)client.unstable.custom_object_instances.delete_custom_object_instances_by_external_id(...)client.unstable.data_export.get_data_export(...)client.unstable.data_attributes.lis_data_attributes(...)client.unstable.data_export.cancel_data_export(...)client.unstable.data_attributes.create_data_attribute(...)client.unstable.data_export.download_data_export(...)client.unstable.data_attributes.update_data_attribute(...)client.unstable.jobs.status(...)client.unstable.data_events.lis_data_events(...)client.unstable.macros.list_macros(...)client.unstable.data_events.create_data_event(...)client.unstable.macros.get_macro(...)client.unstable.data_events.data_event_summaries(...)client.unstable.messages.create_message(...)client.unstable.data_export.create_data_export(...)client.unstable.messages.get_whats_app_message_status(...)client.unstable.data_export.get_data_export(...)client.unstable.news.list_news_items()client.unstable.data_export.cancel_data_export(...)client.unstable.news.create_news_item(...)New costumes in store for this spooky season
", + sender_id=991267834, + state="live", + deliver_silently=True, + labels=["Product", "Update", "New"], + reactions=["😆", "😅"], + newsfeed_assignments=[ + NewsfeedAssignment( + newsfeed_id=53, + published_at=1664638214, + ) + ], ) ``` @@ -18232,7 +22413,7 @@ client.unstable.data_export.cancel_data_export(client.unstable.data_export.download_data_export(...)client.unstable.jobs.status(...)client.unstable.news.retrieve_news_item(...)client.unstable.messages.create_message(...)client.unstable.news.update_news_item(...)New gifts in store for the jolly season
", + sender_id=991267848, + reactions=["😝", "😂"], ) ``` @@ -18465,7 +22599,7 @@ client.unstable.messages.create_message(client.unstable.messages.get_whats_app_message_status(...)client.unstable.news.list_news_items()client.unstable.news.delete_news_item(...)client.unstable.news.create_news_item(...)client.unstable.news.list_live_newsfeed_items(...)New costumes in store for this spooky season
", - sender_id=991267834, - state="live", - deliver_silently=True, - labels=["Product", "Update", "New"], - reactions=["😆", "😅"], - newsfeed_assignments=[ - NewsfeedAssignment( - newsfeed_id=53, - published_at=1664638214, - ) - ], +client.unstable.news.list_live_newsfeed_items( + id="123", ) ``` @@ -18699,7 +22803,7 @@ client.unstable.news.create_news_item(client.unstable.news.list_newsfeeds()client.unstable.news.retrieve_news_item(...)client.unstable.news.retrieve_newsfeed(...)client.unstable.news.update_news_item(...)client.unstable.segments.list_segments(...)New gifts in store for the jolly season
", - sender_id=991267848, - reactions=["😝", "😂"], -) - -``` -client.unstable.news.delete_news_item(...)client.unstable.segments.retrieve_segment(...)client.unstable.news.list_live_newsfeed_items(...)client.unstable.switch.create_phone_switch(...)client.unstable.news.list_newsfeeds()client.unstable.calls.list_calls(...)client.unstable.news.retrieve_newsfeed(...)client.unstable.calls.show_call(...)client.unstable.segments.list_segments(...)client.unstable.calls.show_call_recording(...)client.unstable.segments.retrieve_segment(...)client.unstable.calls.show_call_transcript(...)client.unstable.switch.create_phone_switch(...)client.unstable.calls.list_calls_with_transcripts(...)client.unstable.brands.list_brands()client.unstable.brands.retrieve_brand(...)client.unstable.emails.list_emails()client.unstable.emails.retrieve_email(...)New gifts in store for the jolly season
", ) @@ -281,14 +248,14 @@ def update( return _response.data def delete( - self, article_id: str, *, request_options: typing.Optional[RequestOptions] = None + self, article_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> DeletedArticleObject: """ You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/New gifts in store for the jolly season
", ) @@ -663,14 +599,14 @@ async def main() -> None: return _response.data async def delete( - self, article_id: str, *, request_options: typing.Optional[RequestOptions] = None + self, article_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> DeletedArticleObject: """ You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/New gifts in store for the jolly season
", + ) + """ + _response = self._raw_client.update_internal_article( + internal_article_id, + title=title, + body=body, + author_id=author_id, + owner_id=owner_id, + request_options=request_options, + ) + return _response.data + + def delete_internal_article( + self, internal_article_id: int, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeletedInternalArticleObject: + """ + You can delete a single internal article by making a DELETE request to `https://api.intercom.io/internal_articles/New gifts in store for the jolly season
", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.update_internal_article( + internal_article_id, + title=title, + body=body, + author_id=author_id, + owner_id=owner_id, + request_options=request_options, + ) + return _response.data + + async def delete_internal_article( + self, internal_article_id: int, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeletedInternalArticleObject: + """ + You can delete a single internal article by making a DELETE request to `https://api.intercom.io/internal_articles/New costumes in store for this spooky season
", - sender_id=991267734, + sender_id=991267834, state="live", deliver_silently=True, labels=["Product", "Update", "New"], @@ -143,13 +143,13 @@ def create( ) return _response.data - def find(self, news_item_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> NewsItem: + def find(self, news_item_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> NewsItem: """ You can fetch the details of a single news item. Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. request_options : typing.Optional[RequestOptions] @@ -168,7 +168,7 @@ def find(self, news_item_id: str, *, request_options: typing.Optional[RequestOpt token="YOUR_TOKEN", ) client.news.items.find( - news_item_id="123", + news_item_id=1, ) """ _response = self._raw_client.find(news_item_id, request_options=request_options) @@ -176,7 +176,7 @@ def find(self, news_item_id: str, *, request_options: typing.Optional[RequestOpt def update( self, - news_item_id: str, + news_item_id: int, *, title: str, sender_id: int, @@ -191,7 +191,7 @@ def update( """ Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. title : str @@ -234,10 +234,10 @@ def update( token="YOUR_TOKEN", ) client.news.items.update( - news_item_id="123", + news_item_id=1, title="Christmas is here!", body="New gifts in store for the jolly season
", - sender_id=991267745, + sender_id=991267845, reactions=["😝", "😂"], ) """ @@ -255,13 +255,13 @@ def update( ) return _response.data - def delete(self, news_item_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DeletedObject: + def delete(self, news_item_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> DeletedObject: """ You can delete a single news item. Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. request_options : typing.Optional[RequestOptions] @@ -280,7 +280,7 @@ def delete(self, news_item_id: str, *, request_options: typing.Optional[RequestO token="YOUR_TOKEN", ) client.news.items.delete( - news_item_id="123", + news_item_id=1, ) """ _response = self._raw_client.delete(news_item_id, request_options=request_options) @@ -302,7 +302,7 @@ def with_raw_response(self) -> AsyncRawItemsClient: """ return self._raw_client - async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> PaginatedNewsItemResponse: + async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> PaginatedResponse: """ You can fetch a list of all news items @@ -313,7 +313,7 @@ async def list(self, *, request_options: typing.Optional[RequestOptions] = None) Returns ------- - PaginatedNewsItemResponse + PaginatedResponse successful Examples @@ -402,7 +402,7 @@ async def main() -> None: await client.news.items.create( title="Halloween is here!", body="New costumes in store for this spooky season
", - sender_id=991267734, + sender_id=991267834, state="live", deliver_silently=True, labels=["Product", "Update", "New"], @@ -431,13 +431,13 @@ async def main() -> None: ) return _response.data - async def find(self, news_item_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> NewsItem: + async def find(self, news_item_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> NewsItem: """ You can fetch the details of a single news item. Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. request_options : typing.Optional[RequestOptions] @@ -461,7 +461,7 @@ async def find(self, news_item_id: str, *, request_options: typing.Optional[Requ async def main() -> None: await client.news.items.find( - news_item_id="123", + news_item_id=1, ) @@ -472,7 +472,7 @@ async def main() -> None: async def update( self, - news_item_id: str, + news_item_id: int, *, title: str, sender_id: int, @@ -487,7 +487,7 @@ async def update( """ Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. title : str @@ -535,10 +535,10 @@ async def update( async def main() -> None: await client.news.items.update( - news_item_id="123", + news_item_id=1, title="Christmas is here!", body="New gifts in store for the jolly season
", - sender_id=991267745, + sender_id=991267845, reactions=["😝", "😂"], ) @@ -560,14 +560,14 @@ async def main() -> None: return _response.data async def delete( - self, news_item_id: str, *, request_options: typing.Optional[RequestOptions] = None + self, news_item_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> DeletedObject: """ You can delete a single news item. Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. request_options : typing.Optional[RequestOptions] @@ -591,7 +591,7 @@ async def delete( async def main() -> None: await client.news.items.delete( - news_item_id="123", + news_item_id=1, ) diff --git a/src/intercom/news/items/raw_client.py b/src/intercom/news/items/raw_client.py index 229758a..0262aaf 100644 --- a/src/intercom/news/items/raw_client.py +++ b/src/intercom/news/items/raw_client.py @@ -15,7 +15,7 @@ from ...types.deleted_object import DeletedObject from ...types.error import Error from ...types.news_item_request_state import NewsItemRequestState -from ...types.paginated_news_item_response import PaginatedNewsItemResponse +from ...types.paginated_response import PaginatedResponse from ..types.news_item import NewsItem from ..types.newsfeed_assignment import NewsfeedAssignment @@ -27,9 +27,7 @@ class RawItemsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): self._client_wrapper = client_wrapper - def list( - self, *, request_options: typing.Optional[RequestOptions] = None - ) -> HttpResponse[PaginatedNewsItemResponse]: + def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[PaginatedResponse]: """ You can fetch a list of all news items @@ -40,7 +38,7 @@ def list( Returns ------- - HttpResponse[PaginatedNewsItemResponse] + HttpResponse[PaginatedResponse] successful """ _response = self._client_wrapper.httpx_client.request( @@ -51,9 +49,9 @@ def list( try: if 200 <= _response.status_code < 300: _data = typing.cast( - PaginatedNewsItemResponse, + PaginatedResponse, construct_type( - type_=PaginatedNewsItemResponse, # type: ignore + type_=PaginatedResponse, # type: ignore object_=_response.json(), ), ) @@ -172,14 +170,14 @@ def create( raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def find( - self, news_item_id: str, *, request_options: typing.Optional[RequestOptions] = None + self, news_item_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[NewsItem]: """ You can fetch the details of a single news item. Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. request_options : typing.Optional[RequestOptions] @@ -234,7 +232,7 @@ def find( def update( self, - news_item_id: str, + news_item_id: int, *, title: str, sender_id: int, @@ -249,7 +247,7 @@ def update( """ Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. title : str @@ -343,14 +341,14 @@ def update( raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def delete( - self, news_item_id: str, *, request_options: typing.Optional[RequestOptions] = None + self, news_item_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[DeletedObject]: """ You can delete a single news item. Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. request_options : typing.Optional[RequestOptions] @@ -410,7 +408,7 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper): async def list( self, *, request_options: typing.Optional[RequestOptions] = None - ) -> AsyncHttpResponse[PaginatedNewsItemResponse]: + ) -> AsyncHttpResponse[PaginatedResponse]: """ You can fetch a list of all news items @@ -421,7 +419,7 @@ async def list( Returns ------- - AsyncHttpResponse[PaginatedNewsItemResponse] + AsyncHttpResponse[PaginatedResponse] successful """ _response = await self._client_wrapper.httpx_client.request( @@ -432,9 +430,9 @@ async def list( try: if 200 <= _response.status_code < 300: _data = typing.cast( - PaginatedNewsItemResponse, + PaginatedResponse, construct_type( - type_=PaginatedNewsItemResponse, # type: ignore + type_=PaginatedResponse, # type: ignore object_=_response.json(), ), ) @@ -553,14 +551,14 @@ async def create( raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def find( - self, news_item_id: str, *, request_options: typing.Optional[RequestOptions] = None + self, news_item_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[NewsItem]: """ You can fetch the details of a single news item. Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. request_options : typing.Optional[RequestOptions] @@ -615,7 +613,7 @@ async def find( async def update( self, - news_item_id: str, + news_item_id: int, *, title: str, sender_id: int, @@ -630,7 +628,7 @@ async def update( """ Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. title : str @@ -724,14 +722,14 @@ async def update( raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def delete( - self, news_item_id: str, *, request_options: typing.Optional[RequestOptions] = None + self, news_item_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[DeletedObject]: """ You can delete a single news item. Parameters ---------- - news_item_id : str + news_item_id : int The unique identifier for the news item which is given by Intercom. request_options : typing.Optional[RequestOptions] diff --git a/src/intercom/news/types/news_item.py b/src/intercom/news/types/news_item.py index 0b6b04e..99519ef 100644 --- a/src/intercom/news/types/news_item.py +++ b/src/intercom/news/types/news_item.py @@ -14,37 +14,32 @@ class NewsItem(UncheckedBaseModel): A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers. """ - type: typing.Literal["news-item"] = pydantic.Field(default="news-item") - """ - The type of object. - """ - - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The unique identifier for the news item which is given by Intercom. """ - workspace_id: str = pydantic.Field() + workspace_id: typing.Optional[str] = pydantic.Field(default=None) """ The id of the workspace which the news item belongs to. """ - title: str = pydantic.Field() + title: typing.Optional[str] = pydantic.Field(default=None) """ The title of the news item. """ - body: str = pydantic.Field() + body: typing.Optional[str] = pydantic.Field(default=None) """ The news item body, which may contain HTML. """ - sender_id: int = pydantic.Field() + sender_id: typing.Optional[int] = pydantic.Field(default=None) """ The id of the sender of the news item. Must be a teammate on the workspace. """ - state: NewsItemState = pydantic.Field() + state: typing.Optional[NewsItemState] = pydantic.Field(default=None) """ News items will not be visible to your users in the assigned newsfeeds until they are set live. """ @@ -74,7 +69,7 @@ class NewsItem(UncheckedBaseModel): When set to true, the news item will appear in the messenger newsfeed without showing a notification badge. """ - created_at: int = pydantic.Field() + created_at: typing.Optional[int] = pydantic.Field(default=None) """ Timestamp for when the news item was created. """ diff --git a/src/intercom/news/types/newsfeed.py b/src/intercom/news/types/newsfeed.py index fb64616..c5d0630 100644 --- a/src/intercom/news/types/newsfeed.py +++ b/src/intercom/news/types/newsfeed.py @@ -14,22 +14,17 @@ class Newsfeed(UncheckedBaseModel): Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The unique identifier for the newsfeed which is given by Intercom. """ - type: typing.Literal["newsfeed"] = pydantic.Field(default="newsfeed") - """ - The type of object. - """ - - name: str = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The name of the newsfeed. This name will never be visible to your users. """ - created_at: int = pydantic.Field() + created_at: typing.Optional[int] = pydantic.Field(default=None) """ Timestamp for when the newsfeed was created. """ diff --git a/src/intercom/news/types/newsfeed_assignment.py b/src/intercom/news/types/newsfeed_assignment.py index 94e1299..087b6b8 100644 --- a/src/intercom/news/types/newsfeed_assignment.py +++ b/src/intercom/news/types/newsfeed_assignment.py @@ -12,12 +12,12 @@ class NewsfeedAssignment(UncheckedBaseModel): Assigns a news item to a newsfeed. """ - newsfeed_id: int = pydantic.Field() + newsfeed_id: typing.Optional[int] = pydantic.Field(default=None) """ The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article). """ - published_at: int = pydantic.Field() + published_at: typing.Optional[int] = pydantic.Field(default=None) """ Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is "draft". """ diff --git a/src/intercom/notes/client.py b/src/intercom/notes/client.py index e6ad025..de4e3ed 100644 --- a/src/intercom/notes/client.py +++ b/src/intercom/notes/client.py @@ -121,13 +121,13 @@ def create( _response = self._raw_client.create(contact_id, body=body, admin_id=admin_id, request_options=request_options) return _response.data - def find(self, note_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Note: + def find(self, note_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Note: """ You can fetch the details of a single note. Parameters ---------- - note_id : str + note_id : int The unique identifier of a given note request_options : typing.Optional[RequestOptions] @@ -146,7 +146,7 @@ def find(self, note_id: str, *, request_options: typing.Optional[RequestOptions] token="YOUR_TOKEN", ) client.notes.find( - note_id="1", + note_id=1, ) """ _response = self._raw_client.find(note_id, request_options=request_options) @@ -281,13 +281,13 @@ async def main() -> None: ) return _response.data - async def find(self, note_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Note: + async def find(self, note_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Note: """ You can fetch the details of a single note. Parameters ---------- - note_id : str + note_id : int The unique identifier of a given note request_options : typing.Optional[RequestOptions] @@ -311,7 +311,7 @@ async def find(self, note_id: str, *, request_options: typing.Optional[RequestOp async def main() -> None: await client.notes.find( - note_id="1", + note_id=1, ) diff --git a/src/intercom/notes/raw_client.py b/src/intercom/notes/raw_client.py index 234f5c6..d6b31d0 100644 --- a/src/intercom/notes/raw_client.py +++ b/src/intercom/notes/raw_client.py @@ -170,13 +170,13 @@ def create( raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) - def find(self, note_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Note]: + def find(self, note_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Note]: """ You can fetch the details of a single note. Parameters ---------- - note_id : str + note_id : int The unique identifier of a given note request_options : typing.Optional[RequestOptions] @@ -384,14 +384,14 @@ async def create( raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def find( - self, note_id: str, *, request_options: typing.Optional[RequestOptions] = None + self, note_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[Note]: """ You can fetch the details of a single note. Parameters ---------- - note_id : str + note_id : int The unique identifier of a given note request_options : typing.Optional[RequestOptions] diff --git a/src/intercom/notes/types/note.py b/src/intercom/notes/types/note.py index c5cb3c4..3bddbc5 100644 --- a/src/intercom/notes/types/note.py +++ b/src/intercom/notes/types/note.py @@ -14,17 +14,17 @@ class Note(UncheckedBaseModel): Notes allow you to annotate and comment on your contacts. """ - type: typing.Literal["note"] = pydantic.Field(default="note") + type: typing.Optional[str] = pydantic.Field(default=None) """ String representing the object's type. Always has the value `note`. """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The id of the note. """ - created_at: int = pydantic.Field() + created_at: typing.Optional[int] = pydantic.Field(default=None) """ The time the note was created. """ @@ -34,12 +34,12 @@ class Note(UncheckedBaseModel): Represents the contact that the note was created about. """ - author: Admin = pydantic.Field() + author: typing.Optional[Admin] = pydantic.Field(default=None) """ Optional. Represents the Admin that created the note. """ - body: str = pydantic.Field() + body: typing.Optional[str] = pydantic.Field(default=None) """ The body text of the note. """ diff --git a/src/intercom/notes/types/note_contact.py b/src/intercom/notes/types/note_contact.py index 5258ab7..35a73e5 100644 --- a/src/intercom/notes/types/note_contact.py +++ b/src/intercom/notes/types/note_contact.py @@ -12,7 +12,7 @@ class NoteContact(UncheckedBaseModel): Represents the contact that the note was created about. """ - type: typing.Optional[typing.Literal["contact"]] = pydantic.Field(default=None) + type: typing.Optional[str] = pydantic.Field(default=None) """ String representing the object's type. Always has the value `contact`. """ diff --git a/src/intercom/phone_call_redirects/client.py b/src/intercom/phone_call_redirects/client.py index 5f5157e..b5e4108 100644 --- a/src/intercom/phone_call_redirects/client.py +++ b/src/intercom/phone_call_redirects/client.py @@ -4,7 +4,7 @@ from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ..core.request_options import RequestOptions -from ..types.custom_attributes import CustomAttributes +from ..types.create_phone_switch_request import CreatePhoneSwitchRequest from ..types.phone_switch import PhoneSwitch from .raw_client import AsyncRawPhoneCallRedirectsClient, RawPhoneCallRedirectsClient @@ -30,10 +30,9 @@ def with_raw_response(self) -> RawPhoneCallRedirectsClient: def create( self, *, - phone: str, - custom_attributes: typing.Optional[CustomAttributes] = OMIT, + request: typing.Optional[CreatePhoneSwitchRequest] = None, request_options: typing.Optional[RequestOptions] = None, - ) -> PhoneSwitch: + ) -> typing.Optional[PhoneSwitch]: """ You can use the API to deflect phone calls to the Intercom Messenger. Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. @@ -42,34 +41,31 @@ def create( Parameters ---------- - phone : str - Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger. - - custom_attributes : typing.Optional[CustomAttributes] + request : typing.Optional[CreatePhoneSwitchRequest] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - PhoneSwitch + typing.Optional[PhoneSwitch] successful Examples -------- - from intercom import Intercom + from intercom import CreatePhoneSwitchRequest, Intercom client = Intercom( token="YOUR_TOKEN", ) client.phone_call_redirects.create( - phone="+353832345678", - custom_attributes={"issue_type": "Billing", "priority": "High"}, + request=CreatePhoneSwitchRequest( + phone="+353832345678", + custom_attributes={"issue_type": "Billing", "priority": "High"}, + ), ) """ - _response = self._raw_client.create( - phone=phone, custom_attributes=custom_attributes, request_options=request_options - ) + _response = self._raw_client.create(request=request, request_options=request_options) return _response.data @@ -91,10 +87,9 @@ def with_raw_response(self) -> AsyncRawPhoneCallRedirectsClient: async def create( self, *, - phone: str, - custom_attributes: typing.Optional[CustomAttributes] = OMIT, + request: typing.Optional[CreatePhoneSwitchRequest] = None, request_options: typing.Optional[RequestOptions] = None, - ) -> PhoneSwitch: + ) -> typing.Optional[PhoneSwitch]: """ You can use the API to deflect phone calls to the Intercom Messenger. Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. @@ -103,24 +98,21 @@ async def create( Parameters ---------- - phone : str - Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger. - - custom_attributes : typing.Optional[CustomAttributes] + request : typing.Optional[CreatePhoneSwitchRequest] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - PhoneSwitch + typing.Optional[PhoneSwitch] successful Examples -------- import asyncio - from intercom import AsyncIntercom + from intercom import AsyncIntercom, CreatePhoneSwitchRequest client = AsyncIntercom( token="YOUR_TOKEN", @@ -129,14 +121,14 @@ async def create( async def main() -> None: await client.phone_call_redirects.create( - phone="+353832345678", - custom_attributes={"issue_type": "Billing", "priority": "High"}, + request=CreatePhoneSwitchRequest( + phone="+353832345678", + custom_attributes={"issue_type": "Billing", "priority": "High"}, + ), ) asyncio.run(main()) """ - _response = await self._raw_client.create( - phone=phone, custom_attributes=custom_attributes, request_options=request_options - ) + _response = await self._raw_client.create(request=request, request_options=request_options) return _response.data diff --git a/src/intercom/phone_call_redirects/raw_client.py b/src/intercom/phone_call_redirects/raw_client.py index b76fc65..073d869 100644 --- a/src/intercom/phone_call_redirects/raw_client.py +++ b/src/intercom/phone_call_redirects/raw_client.py @@ -7,11 +7,12 @@ from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ..core.http_response import AsyncHttpResponse, HttpResponse from ..core.request_options import RequestOptions +from ..core.serialization import convert_and_respect_annotation_metadata from ..core.unchecked_base_model import construct_type from ..errors.bad_request_error import BadRequestError from ..errors.unauthorized_error import UnauthorizedError from ..errors.unprocessable_entity_error import UnprocessableEntityError -from ..types.custom_attributes import CustomAttributes +from ..types.create_phone_switch_request import CreatePhoneSwitchRequest from ..types.error import Error from ..types.phone_switch import PhoneSwitch @@ -26,10 +27,9 @@ def __init__(self, *, client_wrapper: SyncClientWrapper): def create( self, *, - phone: str, - custom_attributes: typing.Optional[CustomAttributes] = OMIT, + request: typing.Optional[CreatePhoneSwitchRequest] = None, request_options: typing.Optional[RequestOptions] = None, - ) -> HttpResponse[PhoneSwitch]: + ) -> HttpResponse[typing.Optional[PhoneSwitch]]: """ You can use the API to deflect phone calls to the Intercom Messenger. Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. @@ -38,26 +38,22 @@ def create( Parameters ---------- - phone : str - Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger. - - custom_attributes : typing.Optional[CustomAttributes] + request : typing.Optional[CreatePhoneSwitchRequest] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - HttpResponse[PhoneSwitch] + HttpResponse[typing.Optional[PhoneSwitch]] successful """ _response = self._client_wrapper.httpx_client.request( "phone_call_redirects", method="POST", - json={ - "phone": phone, - "custom_attributes": custom_attributes, - }, + json=convert_and_respect_annotation_metadata( + object_=request, annotation=CreatePhoneSwitchRequest, direction="write" + ), headers={ "content-type": "application/json", }, @@ -65,11 +61,13 @@ def create( omit=OMIT, ) try: + if _response is None or not _response.text.strip(): + return HttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - PhoneSwitch, + typing.Optional[PhoneSwitch], construct_type( - type_=PhoneSwitch, # type: ignore + type_=typing.Optional[PhoneSwitch], # type: ignore object_=_response.json(), ), ) @@ -120,10 +118,9 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper): async def create( self, *, - phone: str, - custom_attributes: typing.Optional[CustomAttributes] = OMIT, + request: typing.Optional[CreatePhoneSwitchRequest] = None, request_options: typing.Optional[RequestOptions] = None, - ) -> AsyncHttpResponse[PhoneSwitch]: + ) -> AsyncHttpResponse[typing.Optional[PhoneSwitch]]: """ You can use the API to deflect phone calls to the Intercom Messenger. Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. @@ -132,26 +129,22 @@ async def create( Parameters ---------- - phone : str - Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger. - - custom_attributes : typing.Optional[CustomAttributes] + request : typing.Optional[CreatePhoneSwitchRequest] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - AsyncHttpResponse[PhoneSwitch] + AsyncHttpResponse[typing.Optional[PhoneSwitch]] successful """ _response = await self._client_wrapper.httpx_client.request( "phone_call_redirects", method="POST", - json={ - "phone": phone, - "custom_attributes": custom_attributes, - }, + json=convert_and_respect_annotation_metadata( + object_=request, annotation=CreatePhoneSwitchRequest, direction="write" + ), headers={ "content-type": "application/json", }, @@ -159,11 +152,13 @@ async def create( omit=OMIT, ) try: + if _response is None or not _response.text.strip(): + return AsyncHttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - PhoneSwitch, + typing.Optional[PhoneSwitch], construct_type( - type_=PhoneSwitch, # type: ignore + type_=typing.Optional[PhoneSwitch], # type: ignore object_=_response.json(), ), ) diff --git a/src/intercom/segments/types/segment.py b/src/intercom/segments/types/segment.py index 8dbd043..b385198 100644 --- a/src/intercom/segments/types/segment.py +++ b/src/intercom/segments/types/segment.py @@ -13,22 +13,22 @@ class Segment(UncheckedBaseModel): A segment is a group of your contacts defined by the rules that you set. """ - type: typing.Literal["segment"] = pydantic.Field(default="segment") + type: typing.Optional[typing.Literal["segment"]] = pydantic.Field(default=None) """ The type of object. """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The unique identifier representing the segment. """ - name: str = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The name of the segment. """ - created_at: int = pydantic.Field() + created_at: typing.Optional[int] = pydantic.Field(default=None) """ The time the segment was created. """ @@ -38,7 +38,7 @@ class Segment(UncheckedBaseModel): The time the segment was updated. """ - person_type: SegmentPersonType = pydantic.Field() + person_type: typing.Optional[SegmentPersonType] = pydantic.Field(default=None) """ Type of the contact: contact (lead) or user. """ diff --git a/src/intercom/subscription_types/types/subscription_type.py b/src/intercom/subscription_types/types/subscription_type.py index fa4dd1a..8f4c0f2 100644 --- a/src/intercom/subscription_types/types/subscription_type.py +++ b/src/intercom/subscription_types/types/subscription_type.py @@ -16,33 +16,33 @@ class SubscriptionType(UncheckedBaseModel): A subscription type lets customers easily opt out of non-essential communications without missing what's important to them. """ - type: typing.Literal["subscription"] = pydantic.Field(default="subscription") + type: typing.Optional[typing.Literal["subscription"]] = pydantic.Field(default=None) """ The type of the object - subscription """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The unique identifier representing the subscription type. """ - state: SubscriptionTypeState = pydantic.Field() + state: typing.Optional[SubscriptionTypeState] = pydantic.Field(default=None) """ The state of the subscription type. """ - default_translation: Translation - translations: typing.List[Translation] = pydantic.Field() + default_translation: typing.Optional[Translation] = None + translations: typing.Optional[typing.List[Translation]] = pydantic.Field(default=None) """ An array of translations objects with the localised version of the subscription type in each available locale within your translation settings. """ - consent_type: SubscriptionTypeConsentType = pydantic.Field() + consent_type: typing.Optional[SubscriptionTypeConsentType] = pydantic.Field(default=None) """ Describes the type of consent. """ - content_types: typing.List[SubscriptionTypeContentTypesItem] = pydantic.Field() + content_types: typing.Optional[typing.List[SubscriptionTypeContentTypesItem]] = pydantic.Field(default=None) """ The message types that this subscription supports - can contain `email` or `sms_message`. """ diff --git a/src/intercom/tags/__init__.py b/src/intercom/tags/__init__.py index fc57985..96b3050 100644 --- a/src/intercom/tags/__init__.py +++ b/src/intercom/tags/__init__.py @@ -2,6 +2,6 @@ # isort: skip_file -from .types import Tag, TagsCreateRequestBody +from .types import Tag, TagBasic, TagsCreateRequestBody -__all__ = ["Tag", "TagsCreateRequestBody"] +__all__ = ["Tag", "TagBasic", "TagsCreateRequestBody"] diff --git a/src/intercom/tags/client.py b/src/intercom/tags/client.py index 0a0579c..fdb545d 100644 --- a/src/intercom/tags/client.py +++ b/src/intercom/tags/client.py @@ -167,7 +167,7 @@ def untag_conversation( conversation_id tag_id : str - id + tag_id admin_id : str The unique identifier for the admin which is given by Intercom. @@ -593,7 +593,7 @@ async def untag_conversation( conversation_id tag_id : str - id + tag_id admin_id : str The unique identifier for the admin which is given by Intercom. diff --git a/src/intercom/tags/raw_client.py b/src/intercom/tags/raw_client.py index e54869d..b5c3565 100644 --- a/src/intercom/tags/raw_client.py +++ b/src/intercom/tags/raw_client.py @@ -258,7 +258,7 @@ def untag_conversation( conversation_id tag_id : str - id + tag_id admin_id : str The unique identifier for the admin which is given by Intercom. @@ -963,7 +963,7 @@ async def untag_conversation( conversation_id tag_id : str - id + tag_id admin_id : str The unique identifier for the admin which is given by Intercom. diff --git a/src/intercom/tags/types/__init__.py b/src/intercom/tags/types/__init__.py index 19ffcaa..95c8e55 100644 --- a/src/intercom/tags/types/__init__.py +++ b/src/intercom/tags/types/__init__.py @@ -3,6 +3,7 @@ # isort: skip_file from .tag import Tag +from .tag_basic import TagBasic from .tags_create_request_body import TagsCreateRequestBody -__all__ = ["Tag", "TagsCreateRequestBody"] +__all__ = ["Tag", "TagBasic", "TagsCreateRequestBody"] diff --git a/src/intercom/tags/types/tag_basic.py b/src/intercom/tags/types/tag_basic.py new file mode 100644 index 0000000..0eaac93 --- /dev/null +++ b/src/intercom/tags/types/tag_basic.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ...core.pydantic_utilities import IS_PYDANTIC_V2 +from ...core.unchecked_base_model import UncheckedBaseModel + + +class TagBasic(UncheckedBaseModel): + """ + A tag allows you to label your contacts, companies, and conversations and list them using that tag. + """ + + type: typing.Optional[str] = pydantic.Field(default=None) + """ + value is "tag" + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The id of the tag + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the tag + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/intercom/teams/types/team.py b/src/intercom/teams/types/team.py index d27fe24..6589e91 100644 --- a/src/intercom/teams/types/team.py +++ b/src/intercom/teams/types/team.py @@ -13,22 +13,22 @@ class Team(UncheckedBaseModel): Teams are groups of admins in Intercom. """ - type: typing.Literal["team"] = pydantic.Field(default="team") + type: typing.Optional[str] = pydantic.Field(default=None) """ Value is always "team" """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The id of the team """ - name: str = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The name of the team """ - admin_ids: typing.List[int] = pydantic.Field() + admin_ids: typing.Optional[typing.List[int]] = pydantic.Field(default=None) """ The list of admin IDs that are a part of the team. """ diff --git a/src/intercom/ticket_states/__init__.py b/src/intercom/ticket_states/__init__.py new file mode 100644 index 0000000..5cde020 --- /dev/null +++ b/src/intercom/ticket_states/__init__.py @@ -0,0 +1,4 @@ +# This file was auto-generated by Fern from our API Definition. + +# isort: skip_file + diff --git a/src/intercom/ticket_states/client.py b/src/intercom/ticket_states/client.py new file mode 100644 index 0000000..f61c4c5 --- /dev/null +++ b/src/intercom/ticket_states/client.py @@ -0,0 +1,100 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ..core.request_options import RequestOptions +from ..types.ticket_state_list import TicketStateList +from .raw_client import AsyncRawTicketStatesClient, RawTicketStatesClient + + +class TicketStatesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawTicketStatesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawTicketStatesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawTicketStatesClient + """ + return self._raw_client + + def list_ticket_states(self, *, request_options: typing.Optional[RequestOptions] = None) -> TicketStateList: + """ + You can get a list of all ticket states for a workspace. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + TicketStateList + successful + + Examples + -------- + from intercom import Intercom + + client = Intercom( + token="YOUR_TOKEN", + ) + client.ticket_states.list_ticket_states() + """ + _response = self._raw_client.list_ticket_states(request_options=request_options) + return _response.data + + +class AsyncTicketStatesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawTicketStatesClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawTicketStatesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawTicketStatesClient + """ + return self._raw_client + + async def list_ticket_states(self, *, request_options: typing.Optional[RequestOptions] = None) -> TicketStateList: + """ + You can get a list of all ticket states for a workspace. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + TicketStateList + successful + + Examples + -------- + import asyncio + + from intercom import AsyncIntercom + + client = AsyncIntercom( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.ticket_states.list_ticket_states() + + + asyncio.run(main()) + """ + _response = await self._raw_client.list_ticket_states(request_options=request_options) + return _response.data diff --git a/src/intercom/ticket_states/raw_client.py b/src/intercom/ticket_states/raw_client.py new file mode 100644 index 0000000..b42d577 --- /dev/null +++ b/src/intercom/ticket_states/raw_client.py @@ -0,0 +1,117 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ..core.api_error import ApiError +from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ..core.http_response import AsyncHttpResponse, HttpResponse +from ..core.request_options import RequestOptions +from ..core.unchecked_base_model import construct_type +from ..errors.unauthorized_error import UnauthorizedError +from ..types.error import Error +from ..types.ticket_state_list import TicketStateList + + +class RawTicketStatesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list_ticket_states( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[TicketStateList]: + """ + You can get a list of all ticket states for a workspace. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[TicketStateList] + successful + """ + _response = self._client_wrapper.httpx_client.request( + "ticket_states", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + TicketStateList, + construct_type( + type_=TicketStateList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + construct_type( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawTicketStatesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list_ticket_states( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[TicketStateList]: + """ + You can get a list of all ticket states for a workspace. + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[TicketStateList] + successful + """ + _response = await self._client_wrapper.httpx_client.request( + "ticket_states", + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + TicketStateList, + construct_type( + type_=TicketStateList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + construct_type( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/intercom/ticket_types/__init__.py b/src/intercom/ticket_types/__init__.py index 9eee489..1e2a69c 100644 --- a/src/intercom/ticket_types/__init__.py +++ b/src/intercom/ticket_types/__init__.py @@ -2,13 +2,8 @@ # isort: skip_file -from .types import CreateTicketTypeRequestCategory, UpdateTicketTypeRequestBodyCategory +from .types import UpdateTicketTypeRequestCategory from . import attributes from .attributes import CreateTicketTypeAttributeRequestDataType -__all__ = [ - "CreateTicketTypeAttributeRequestDataType", - "CreateTicketTypeRequestCategory", - "UpdateTicketTypeRequestBodyCategory", - "attributes", -] +__all__ = ["CreateTicketTypeAttributeRequestDataType", "UpdateTicketTypeRequestCategory", "attributes"] diff --git a/src/intercom/ticket_types/attributes/client.py b/src/intercom/ticket_types/attributes/client.py index 4cb02c5..443b17a 100644 --- a/src/intercom/ticket_types/attributes/client.py +++ b/src/intercom/ticket_types/attributes/client.py @@ -42,7 +42,7 @@ def create( list_items: typing.Optional[str] = OMIT, allow_multiple_values: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> TicketTypeAttribute: + ) -> typing.Optional[TicketTypeAttribute]: """ You can create a new attribute for a ticket type. @@ -86,7 +86,7 @@ def create( Returns ------- - TicketTypeAttribute + typing.Optional[TicketTypeAttribute] Ticket Type Attribute created Examples @@ -136,7 +136,7 @@ def update( allow_multiple_values: typing.Optional[bool] = OMIT, archived: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> TicketTypeAttribute: + ) -> typing.Optional[TicketTypeAttribute]: """ You can update an existing attribute for a ticket type. @@ -183,7 +183,7 @@ def update( Returns ------- - TicketTypeAttribute + typing.Optional[TicketTypeAttribute] Ticket Type Attribute updated Examples @@ -247,7 +247,7 @@ async def create( list_items: typing.Optional[str] = OMIT, allow_multiple_values: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> TicketTypeAttribute: + ) -> typing.Optional[TicketTypeAttribute]: """ You can create a new attribute for a ticket type. @@ -291,7 +291,7 @@ async def create( Returns ------- - TicketTypeAttribute + typing.Optional[TicketTypeAttribute] Ticket Type Attribute created Examples @@ -349,7 +349,7 @@ async def update( allow_multiple_values: typing.Optional[bool] = OMIT, archived: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> TicketTypeAttribute: + ) -> typing.Optional[TicketTypeAttribute]: """ You can update an existing attribute for a ticket type. @@ -396,7 +396,7 @@ async def update( Returns ------- - TicketTypeAttribute + typing.Optional[TicketTypeAttribute] Ticket Type Attribute updated Examples diff --git a/src/intercom/ticket_types/attributes/raw_client.py b/src/intercom/ticket_types/attributes/raw_client.py index 0de72e8..4e47e00 100644 --- a/src/intercom/ticket_types/attributes/raw_client.py +++ b/src/intercom/ticket_types/attributes/raw_client.py @@ -37,7 +37,7 @@ def create( list_items: typing.Optional[str] = OMIT, allow_multiple_values: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> HttpResponse[TicketTypeAttribute]: + ) -> HttpResponse[typing.Optional[TicketTypeAttribute]]: """ You can create a new attribute for a ticket type. @@ -81,7 +81,7 @@ def create( Returns ------- - HttpResponse[TicketTypeAttribute] + HttpResponse[typing.Optional[TicketTypeAttribute]] Ticket Type Attribute created """ _response = self._client_wrapper.httpx_client.request( @@ -106,11 +106,13 @@ def create( omit=OMIT, ) try: + if _response is None or not _response.text.strip(): + return HttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - TicketTypeAttribute, + typing.Optional[TicketTypeAttribute], construct_type( - type_=TicketTypeAttribute, # type: ignore + type_=typing.Optional[TicketTypeAttribute], # type: ignore object_=_response.json(), ), ) @@ -147,7 +149,7 @@ def update( allow_multiple_values: typing.Optional[bool] = OMIT, archived: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> HttpResponse[TicketTypeAttribute]: + ) -> HttpResponse[typing.Optional[TicketTypeAttribute]]: """ You can update an existing attribute for a ticket type. @@ -194,7 +196,7 @@ def update( Returns ------- - HttpResponse[TicketTypeAttribute] + HttpResponse[typing.Optional[TicketTypeAttribute]] Ticket Type Attribute updated """ _response = self._client_wrapper.httpx_client.request( @@ -219,11 +221,13 @@ def update( omit=OMIT, ) try: + if _response is None or not _response.text.strip(): + return HttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - TicketTypeAttribute, + typing.Optional[TicketTypeAttribute], construct_type( - type_=TicketTypeAttribute, # type: ignore + type_=typing.Optional[TicketTypeAttribute], # type: ignore object_=_response.json(), ), ) @@ -264,7 +268,7 @@ async def create( list_items: typing.Optional[str] = OMIT, allow_multiple_values: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> AsyncHttpResponse[TicketTypeAttribute]: + ) -> AsyncHttpResponse[typing.Optional[TicketTypeAttribute]]: """ You can create a new attribute for a ticket type. @@ -308,7 +312,7 @@ async def create( Returns ------- - AsyncHttpResponse[TicketTypeAttribute] + AsyncHttpResponse[typing.Optional[TicketTypeAttribute]] Ticket Type Attribute created """ _response = await self._client_wrapper.httpx_client.request( @@ -333,11 +337,13 @@ async def create( omit=OMIT, ) try: + if _response is None or not _response.text.strip(): + return AsyncHttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - TicketTypeAttribute, + typing.Optional[TicketTypeAttribute], construct_type( - type_=TicketTypeAttribute, # type: ignore + type_=typing.Optional[TicketTypeAttribute], # type: ignore object_=_response.json(), ), ) @@ -374,7 +380,7 @@ async def update( allow_multiple_values: typing.Optional[bool] = OMIT, archived: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> AsyncHttpResponse[TicketTypeAttribute]: + ) -> AsyncHttpResponse[typing.Optional[TicketTypeAttribute]]: """ You can update an existing attribute for a ticket type. @@ -421,7 +427,7 @@ async def update( Returns ------- - AsyncHttpResponse[TicketTypeAttribute] + AsyncHttpResponse[typing.Optional[TicketTypeAttribute]] Ticket Type Attribute updated """ _response = await self._client_wrapper.httpx_client.request( @@ -446,11 +452,13 @@ async def update( omit=OMIT, ) try: + if _response is None or not _response.text.strip(): + return AsyncHttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - TicketTypeAttribute, + typing.Optional[TicketTypeAttribute], construct_type( - type_=TicketTypeAttribute, # type: ignore + type_=typing.Optional[TicketTypeAttribute], # type: ignore object_=_response.json(), ), ) diff --git a/src/intercom/ticket_types/client.py b/src/intercom/ticket_types/client.py index c01dd27..0ed4c8e 100644 --- a/src/intercom/ticket_types/client.py +++ b/src/intercom/ticket_types/client.py @@ -5,11 +5,11 @@ from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ..core.request_options import RequestOptions from ..tickets.types.ticket_type import TicketType +from ..types.create_ticket_type_request import CreateTicketTypeRequest from ..types.ticket_type_list import TicketTypeList from .attributes.client import AsyncAttributesClient, AttributesClient from .raw_client import AsyncRawTicketTypesClient, RawTicketTypesClient -from .types.create_ticket_type_request_category import CreateTicketTypeRequestCategory -from .types.update_ticket_type_request_body_category import UpdateTicketTypeRequestBodyCategory +from .types.update_ticket_type_request_category import UpdateTicketTypeRequestCategory # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -60,13 +60,9 @@ def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> Ti def create( self, *, - name: str, - description: typing.Optional[str] = OMIT, - category: typing.Optional[CreateTicketTypeRequestCategory] = OMIT, - icon: typing.Optional[str] = OMIT, - is_internal: typing.Optional[bool] = OMIT, + request: typing.Optional[CreateTicketTypeRequest] = None, request_options: typing.Optional[RequestOptions] = None, - ) -> TicketType: + ) -> typing.Optional[TicketType]: """ You can create a new ticket type. > 📘 Creating ticket types. @@ -76,54 +72,38 @@ def create( Parameters ---------- - name : str - The name of the ticket type. - - description : typing.Optional[str] - The description of the ticket type. - - category : typing.Optional[CreateTicketTypeRequestCategory] - Category of the Ticket Type. - - icon : typing.Optional[str] - The icon of the ticket type. - - is_internal : typing.Optional[bool] - Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute. + request : typing.Optional[CreateTicketTypeRequest] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - TicketType + typing.Optional[TicketType] Ticket type created Examples -------- - from intercom import Intercom + from intercom import CreateTicketTypeRequest, Intercom client = Intercom( token="YOUR_TOKEN", ) client.ticket_types.create( - name="Customer Issue", - description="Customer Report Template", - category="Customer", - icon="🎟️", + request=CreateTicketTypeRequest( + name="Customer Issue", + description="Customer Report Template", + category="Customer", + icon="🎟️", + ), ) """ - _response = self._raw_client.create( - name=name, - description=description, - category=category, - icon=icon, - is_internal=is_internal, - request_options=request_options, - ) + _response = self._raw_client.create(request=request, request_options=request_options) return _response.data - def get(self, ticket_type_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> TicketType: + def get( + self, ticket_type_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> typing.Optional[TicketType]: """ You can fetch the details of a single ticket type. @@ -137,7 +117,7 @@ def get(self, ticket_type_id: str, *, request_options: typing.Optional[RequestOp Returns ------- - TicketType + typing.Optional[TicketType] Ticket type found Examples @@ -160,12 +140,12 @@ def update( *, name: typing.Optional[str] = OMIT, description: typing.Optional[str] = OMIT, - category: typing.Optional[UpdateTicketTypeRequestBodyCategory] = OMIT, + category: typing.Optional[UpdateTicketTypeRequestCategory] = OMIT, icon: typing.Optional[str] = OMIT, archived: typing.Optional[bool] = OMIT, is_internal: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> TicketType: + ) -> typing.Optional[TicketType]: """ You can update a ticket type. @@ -185,7 +165,7 @@ def update( description : typing.Optional[str] The description of the ticket type. - category : typing.Optional[UpdateTicketTypeRequestBodyCategory] + category : typing.Optional[UpdateTicketTypeRequestCategory] Category of the Ticket Type. icon : typing.Optional[str] @@ -202,7 +182,7 @@ def update( Returns ------- - TicketType + typing.Optional[TicketType] Ticket type updated Examples @@ -283,13 +263,9 @@ async def main() -> None: async def create( self, *, - name: str, - description: typing.Optional[str] = OMIT, - category: typing.Optional[CreateTicketTypeRequestCategory] = OMIT, - icon: typing.Optional[str] = OMIT, - is_internal: typing.Optional[bool] = OMIT, + request: typing.Optional[CreateTicketTypeRequest] = None, request_options: typing.Optional[RequestOptions] = None, - ) -> TicketType: + ) -> typing.Optional[TicketType]: """ You can create a new ticket type. > 📘 Creating ticket types. @@ -299,34 +275,21 @@ async def create( Parameters ---------- - name : str - The name of the ticket type. - - description : typing.Optional[str] - The description of the ticket type. - - category : typing.Optional[CreateTicketTypeRequestCategory] - Category of the Ticket Type. - - icon : typing.Optional[str] - The icon of the ticket type. - - is_internal : typing.Optional[bool] - Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute. + request : typing.Optional[CreateTicketTypeRequest] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - TicketType + typing.Optional[TicketType] Ticket type created Examples -------- import asyncio - from intercom import AsyncIntercom + from intercom import AsyncIntercom, CreateTicketTypeRequest client = AsyncIntercom( token="YOUR_TOKEN", @@ -335,26 +298,23 @@ async def create( async def main() -> None: await client.ticket_types.create( - name="Customer Issue", - description="Customer Report Template", - category="Customer", - icon="🎟️", + request=CreateTicketTypeRequest( + name="Customer Issue", + description="Customer Report Template", + category="Customer", + icon="🎟️", + ), ) asyncio.run(main()) """ - _response = await self._raw_client.create( - name=name, - description=description, - category=category, - icon=icon, - is_internal=is_internal, - request_options=request_options, - ) + _response = await self._raw_client.create(request=request, request_options=request_options) return _response.data - async def get(self, ticket_type_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> TicketType: + async def get( + self, ticket_type_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> typing.Optional[TicketType]: """ You can fetch the details of a single ticket type. @@ -368,7 +328,7 @@ async def get(self, ticket_type_id: str, *, request_options: typing.Optional[Req Returns ------- - TicketType + typing.Optional[TicketType] Ticket type found Examples @@ -399,12 +359,12 @@ async def update( *, name: typing.Optional[str] = OMIT, description: typing.Optional[str] = OMIT, - category: typing.Optional[UpdateTicketTypeRequestBodyCategory] = OMIT, + category: typing.Optional[UpdateTicketTypeRequestCategory] = OMIT, icon: typing.Optional[str] = OMIT, archived: typing.Optional[bool] = OMIT, is_internal: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> TicketType: + ) -> typing.Optional[TicketType]: """ You can update a ticket type. @@ -424,7 +384,7 @@ async def update( description : typing.Optional[str] The description of the ticket type. - category : typing.Optional[UpdateTicketTypeRequestBodyCategory] + category : typing.Optional[UpdateTicketTypeRequestCategory] Category of the Ticket Type. icon : typing.Optional[str] @@ -441,7 +401,7 @@ async def update( Returns ------- - TicketType + typing.Optional[TicketType] Ticket type updated Examples diff --git a/src/intercom/ticket_types/raw_client.py b/src/intercom/ticket_types/raw_client.py index b031dad..7e70ed6 100644 --- a/src/intercom/ticket_types/raw_client.py +++ b/src/intercom/ticket_types/raw_client.py @@ -8,13 +8,14 @@ from ..core.http_response import AsyncHttpResponse, HttpResponse from ..core.jsonable_encoder import jsonable_encoder from ..core.request_options import RequestOptions +from ..core.serialization import convert_and_respect_annotation_metadata from ..core.unchecked_base_model import construct_type from ..errors.unauthorized_error import UnauthorizedError from ..tickets.types.ticket_type import TicketType +from ..types.create_ticket_type_request import CreateTicketTypeRequest from ..types.error import Error from ..types.ticket_type_list import TicketTypeList -from .types.create_ticket_type_request_category import CreateTicketTypeRequestCategory -from .types.update_ticket_type_request_body_category import UpdateTicketTypeRequestBodyCategory +from .types.update_ticket_type_request_category import UpdateTicketTypeRequestCategory # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -72,13 +73,9 @@ def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> Ht def create( self, *, - name: str, - description: typing.Optional[str] = OMIT, - category: typing.Optional[CreateTicketTypeRequestCategory] = OMIT, - icon: typing.Optional[str] = OMIT, - is_internal: typing.Optional[bool] = OMIT, + request: typing.Optional[CreateTicketTypeRequest] = None, request_options: typing.Optional[RequestOptions] = None, - ) -> HttpResponse[TicketType]: + ) -> HttpResponse[typing.Optional[TicketType]]: """ You can create a new ticket type. > 📘 Creating ticket types. @@ -88,39 +85,22 @@ def create( Parameters ---------- - name : str - The name of the ticket type. - - description : typing.Optional[str] - The description of the ticket type. - - category : typing.Optional[CreateTicketTypeRequestCategory] - Category of the Ticket Type. - - icon : typing.Optional[str] - The icon of the ticket type. - - is_internal : typing.Optional[bool] - Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute. + request : typing.Optional[CreateTicketTypeRequest] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - HttpResponse[TicketType] + HttpResponse[typing.Optional[TicketType]] Ticket type created """ _response = self._client_wrapper.httpx_client.request( "ticket_types", method="POST", - json={ - "name": name, - "description": description, - "category": category, - "icon": icon, - "is_internal": is_internal, - }, + json=convert_and_respect_annotation_metadata( + object_=request, annotation=CreateTicketTypeRequest, direction="write" + ), headers={ "content-type": "application/json", }, @@ -128,11 +108,13 @@ def create( omit=OMIT, ) try: + if _response is None or not _response.text.strip(): + return HttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - TicketType, + typing.Optional[TicketType], construct_type( - type_=TicketType, # type: ignore + type_=typing.Optional[TicketType], # type: ignore object_=_response.json(), ), ) @@ -155,7 +137,7 @@ def create( def get( self, ticket_type_id: str, *, request_options: typing.Optional[RequestOptions] = None - ) -> HttpResponse[TicketType]: + ) -> HttpResponse[typing.Optional[TicketType]]: """ You can fetch the details of a single ticket type. @@ -169,7 +151,7 @@ def get( Returns ------- - HttpResponse[TicketType] + HttpResponse[typing.Optional[TicketType]] Ticket type found """ _response = self._client_wrapper.httpx_client.request( @@ -178,11 +160,13 @@ def get( request_options=request_options, ) try: + if _response is None or not _response.text.strip(): + return HttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - TicketType, + typing.Optional[TicketType], construct_type( - type_=TicketType, # type: ignore + type_=typing.Optional[TicketType], # type: ignore object_=_response.json(), ), ) @@ -209,12 +193,12 @@ def update( *, name: typing.Optional[str] = OMIT, description: typing.Optional[str] = OMIT, - category: typing.Optional[UpdateTicketTypeRequestBodyCategory] = OMIT, + category: typing.Optional[UpdateTicketTypeRequestCategory] = OMIT, icon: typing.Optional[str] = OMIT, archived: typing.Optional[bool] = OMIT, is_internal: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> HttpResponse[TicketType]: + ) -> HttpResponse[typing.Optional[TicketType]]: """ You can update a ticket type. @@ -234,7 +218,7 @@ def update( description : typing.Optional[str] The description of the ticket type. - category : typing.Optional[UpdateTicketTypeRequestBodyCategory] + category : typing.Optional[UpdateTicketTypeRequestCategory] Category of the Ticket Type. icon : typing.Optional[str] @@ -251,7 +235,7 @@ def update( Returns ------- - HttpResponse[TicketType] + HttpResponse[typing.Optional[TicketType]] Ticket type updated """ _response = self._client_wrapper.httpx_client.request( @@ -272,11 +256,13 @@ def update( omit=OMIT, ) try: + if _response is None or not _response.text.strip(): + return HttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - TicketType, + typing.Optional[TicketType], construct_type( - type_=TicketType, # type: ignore + type_=typing.Optional[TicketType], # type: ignore object_=_response.json(), ), ) @@ -352,13 +338,9 @@ async def list( async def create( self, *, - name: str, - description: typing.Optional[str] = OMIT, - category: typing.Optional[CreateTicketTypeRequestCategory] = OMIT, - icon: typing.Optional[str] = OMIT, - is_internal: typing.Optional[bool] = OMIT, + request: typing.Optional[CreateTicketTypeRequest] = None, request_options: typing.Optional[RequestOptions] = None, - ) -> AsyncHttpResponse[TicketType]: + ) -> AsyncHttpResponse[typing.Optional[TicketType]]: """ You can create a new ticket type. > 📘 Creating ticket types. @@ -368,39 +350,22 @@ async def create( Parameters ---------- - name : str - The name of the ticket type. - - description : typing.Optional[str] - The description of the ticket type. - - category : typing.Optional[CreateTicketTypeRequestCategory] - Category of the Ticket Type. - - icon : typing.Optional[str] - The icon of the ticket type. - - is_internal : typing.Optional[bool] - Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute. + request : typing.Optional[CreateTicketTypeRequest] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - AsyncHttpResponse[TicketType] + AsyncHttpResponse[typing.Optional[TicketType]] Ticket type created """ _response = await self._client_wrapper.httpx_client.request( "ticket_types", method="POST", - json={ - "name": name, - "description": description, - "category": category, - "icon": icon, - "is_internal": is_internal, - }, + json=convert_and_respect_annotation_metadata( + object_=request, annotation=CreateTicketTypeRequest, direction="write" + ), headers={ "content-type": "application/json", }, @@ -408,11 +373,13 @@ async def create( omit=OMIT, ) try: + if _response is None or not _response.text.strip(): + return AsyncHttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - TicketType, + typing.Optional[TicketType], construct_type( - type_=TicketType, # type: ignore + type_=typing.Optional[TicketType], # type: ignore object_=_response.json(), ), ) @@ -435,7 +402,7 @@ async def create( async def get( self, ticket_type_id: str, *, request_options: typing.Optional[RequestOptions] = None - ) -> AsyncHttpResponse[TicketType]: + ) -> AsyncHttpResponse[typing.Optional[TicketType]]: """ You can fetch the details of a single ticket type. @@ -449,7 +416,7 @@ async def get( Returns ------- - AsyncHttpResponse[TicketType] + AsyncHttpResponse[typing.Optional[TicketType]] Ticket type found """ _response = await self._client_wrapper.httpx_client.request( @@ -458,11 +425,13 @@ async def get( request_options=request_options, ) try: + if _response is None or not _response.text.strip(): + return AsyncHttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - TicketType, + typing.Optional[TicketType], construct_type( - type_=TicketType, # type: ignore + type_=typing.Optional[TicketType], # type: ignore object_=_response.json(), ), ) @@ -489,12 +458,12 @@ async def update( *, name: typing.Optional[str] = OMIT, description: typing.Optional[str] = OMIT, - category: typing.Optional[UpdateTicketTypeRequestBodyCategory] = OMIT, + category: typing.Optional[UpdateTicketTypeRequestCategory] = OMIT, icon: typing.Optional[str] = OMIT, archived: typing.Optional[bool] = OMIT, is_internal: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> AsyncHttpResponse[TicketType]: + ) -> AsyncHttpResponse[typing.Optional[TicketType]]: """ You can update a ticket type. @@ -514,7 +483,7 @@ async def update( description : typing.Optional[str] The description of the ticket type. - category : typing.Optional[UpdateTicketTypeRequestBodyCategory] + category : typing.Optional[UpdateTicketTypeRequestCategory] Category of the Ticket Type. icon : typing.Optional[str] @@ -531,7 +500,7 @@ async def update( Returns ------- - AsyncHttpResponse[TicketType] + AsyncHttpResponse[typing.Optional[TicketType]] Ticket type updated """ _response = await self._client_wrapper.httpx_client.request( @@ -552,11 +521,13 @@ async def update( omit=OMIT, ) try: + if _response is None or not _response.text.strip(): + return AsyncHttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - TicketType, + typing.Optional[TicketType], construct_type( - type_=TicketType, # type: ignore + type_=typing.Optional[TicketType], # type: ignore object_=_response.json(), ), ) diff --git a/src/intercom/ticket_types/types/__init__.py b/src/intercom/ticket_types/types/__init__.py index 9f90de2..de326a3 100644 --- a/src/intercom/ticket_types/types/__init__.py +++ b/src/intercom/ticket_types/types/__init__.py @@ -2,7 +2,6 @@ # isort: skip_file -from .create_ticket_type_request_category import CreateTicketTypeRequestCategory -from .update_ticket_type_request_body_category import UpdateTicketTypeRequestBodyCategory +from .update_ticket_type_request_category import UpdateTicketTypeRequestCategory -__all__ = ["CreateTicketTypeRequestCategory", "UpdateTicketTypeRequestBodyCategory"] +__all__ = ["UpdateTicketTypeRequestCategory"] diff --git a/src/intercom/ticket_types/types/update_ticket_type_request_body_category.py b/src/intercom/ticket_types/types/update_ticket_type_request_body_category.py deleted file mode 100644 index 2dc9d82..0000000 --- a/src/intercom/ticket_types/types/update_ticket_type_request_body_category.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -UpdateTicketTypeRequestBodyCategory = typing.Union[typing.Literal["Customer", "Back-office", "Tracker"], typing.Any] diff --git a/src/intercom/unstable/types/update_ticket_type_request_category.py b/src/intercom/ticket_types/types/update_ticket_type_request_category.py similarity index 100% rename from src/intercom/unstable/types/update_ticket_type_request_category.py rename to src/intercom/ticket_types/types/update_ticket_type_request_category.py diff --git a/src/intercom/tickets/__init__.py b/src/intercom/tickets/__init__.py index 2b84247..0b43a42 100644 --- a/src/intercom/tickets/__init__.py +++ b/src/intercom/tickets/__init__.py @@ -3,31 +3,49 @@ # isort: skip_file from .types import ( + DeleteTicketResponse, Ticket, TicketCategory, TicketContacts, TicketPart, TicketPartPreviousTicketState, TicketPartTicketState, - TicketTicketState, + TicketPartUpdatedAttributeData, + TicketPartUpdatedAttributeDataAttribute, + TicketPartUpdatedAttributeDataValue, + TicketPartUpdatedAttributeDataValueId, + TicketPartUpdatedAttributeDataValueLabel, + TicketState, + TicketStateCategory, + TicketStateDetailed, + TicketStateDetailedCategory, + TicketStateDetailedTicketTypes, TicketType, TicketTypeCategory, + TicketTypeTicketStates, TicketsReplyRequestBody, - UpdateTicketRequestAssignment, - UpdateTicketRequestState, ) __all__ = [ + "DeleteTicketResponse", "Ticket", "TicketCategory", "TicketContacts", "TicketPart", "TicketPartPreviousTicketState", "TicketPartTicketState", - "TicketTicketState", + "TicketPartUpdatedAttributeData", + "TicketPartUpdatedAttributeDataAttribute", + "TicketPartUpdatedAttributeDataValue", + "TicketPartUpdatedAttributeDataValueId", + "TicketPartUpdatedAttributeDataValueLabel", + "TicketState", + "TicketStateCategory", + "TicketStateDetailed", + "TicketStateDetailedCategory", + "TicketStateDetailedTicketTypes", "TicketType", "TicketTypeCategory", + "TicketTypeTicketStates", "TicketsReplyRequestBody", - "UpdateTicketRequestAssignment", - "UpdateTicketRequestState", ] diff --git a/src/intercom/tickets/client.py b/src/intercom/tickets/client.py index 03cb766..30ce992 100644 --- a/src/intercom/tickets/client.py +++ b/src/intercom/tickets/client.py @@ -5,16 +5,16 @@ from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ..core.pagination import AsyncPager, SyncPager from ..core.request_options import RequestOptions +from ..jobs.types.jobs import Jobs +from ..types.create_ticket_request_assignment import CreateTicketRequestAssignment from ..types.create_ticket_request_contacts_item import CreateTicketRequestContactsItem from ..types.search_request_query import SearchRequestQuery from ..types.starting_after_paging import StartingAfterPaging from ..types.ticket_reply import TicketReply -from ..types.ticket_request_custom_attributes import TicketRequestCustomAttributes from .raw_client import AsyncRawTicketsClient, RawTicketsClient +from .types.delete_ticket_response import DeleteTicketResponse from .types.ticket import Ticket from .types.tickets_reply_request_body import TicketsReplyRequestBody -from .types.update_ticket_request_assignment import UpdateTicketRequestAssignment -from .types.update_ticket_request_state import UpdateTicketRequestState # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -57,7 +57,7 @@ def reply( Returns ------- TicketReply - Admin quick_reply reply + Admin Reply to send Quick Reply Options Examples -------- @@ -70,7 +70,7 @@ def reply( ticket_id="123", request=ContactReplyTicketIntercomUserIdRequest( body="Thanks again :)", - intercom_user_id="667d619d8a68186f43bafe82", + intercom_user_id="6762f2971bb69f9f2193bc49", ), ) """ @@ -82,11 +82,13 @@ def create( *, ticket_type_id: str, contacts: typing.Sequence[CreateTicketRequestContactsItem], + skip_notifications: typing.Optional[bool] = OMIT, + conversation_to_link_id: typing.Optional[str] = OMIT, company_id: typing.Optional[str] = OMIT, created_at: typing.Optional[int] = OMIT, - ticket_attributes: typing.Optional[TicketRequestCustomAttributes] = OMIT, + assignment: typing.Optional[CreateTicketRequestAssignment] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> Ticket: + ) -> typing.Optional[Ticket]: """ You can create a new ticket. @@ -98,20 +100,30 @@ def create( contacts : typing.Sequence[CreateTicketRequestContactsItem] The list of contacts (users or leads) affected by this ticket. Currently only one is allowed + skip_notifications : typing.Optional[bool] + Option to disable notifications when a Ticket is created. + + conversation_to_link_id : typing.Optional[str] + The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets: + - conversation | back-office ticket + - customer tickets | non-shared back-office ticket + - conversation | tracker ticket + - customer ticket | tracker ticket + company_id : typing.Optional[str] - The ID of the company that the ticket is associated with. The ID that you set upon company creation. + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom created_at : typing.Optional[int] The time the ticket was created. If not provided, the current time will be used. - ticket_attributes : typing.Optional[TicketRequestCustomAttributes] + assignment : typing.Optional[CreateTicketRequestAssignment] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - Ticket + typing.Optional[Ticket] Successful response Examples @@ -125,26 +137,103 @@ def create( ticket_type_id="1234", contacts=[ CreateTicketRequestContactsItemId( - id="667d61b78a68186f43bafe8d", + id="6762f2d81bb69f9f2193bc54", ) ], - ticket_attributes={ - "_default_title_": "example", - "_default_description_": "there is a problem", - }, ) """ _response = self._raw_client.create( ticket_type_id=ticket_type_id, contacts=contacts, + skip_notifications=skip_notifications, + conversation_to_link_id=conversation_to_link_id, company_id=company_id, created_at=created_at, - ticket_attributes=ticket_attributes, + assignment=assignment, + request_options=request_options, + ) + return _response.data + + def enqueue_create_ticket( + self, + *, + ticket_type_id: str, + contacts: typing.Sequence[CreateTicketRequestContactsItem], + skip_notifications: typing.Optional[bool] = OMIT, + conversation_to_link_id: typing.Optional[str] = OMIT, + company_id: typing.Optional[str] = OMIT, + created_at: typing.Optional[int] = OMIT, + assignment: typing.Optional[CreateTicketRequestAssignment] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> Jobs: + """ + Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + + Parameters + ---------- + ticket_type_id : str + The ID of the type of ticket you want to create + + contacts : typing.Sequence[CreateTicketRequestContactsItem] + The list of contacts (users or leads) affected by this ticket. Currently only one is allowed + + skip_notifications : typing.Optional[bool] + Option to disable notifications when a Ticket is created. + + conversation_to_link_id : typing.Optional[str] + The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets: + - conversation | back-office ticket + - customer tickets | non-shared back-office ticket + - conversation | tracker ticket + - customer ticket | tracker ticket + + company_id : typing.Optional[str] + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom + + created_at : typing.Optional[int] + The time the ticket was created. If not provided, the current time will be used. + + assignment : typing.Optional[CreateTicketRequestAssignment] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + Jobs + Successful response + + Examples + -------- + from intercom import CreateTicketRequestContactsItemId, Intercom + + client = Intercom( + token="YOUR_TOKEN", + ) + client.tickets.enqueue_create_ticket( + ticket_type_id="1234", + contacts=[ + CreateTicketRequestContactsItemId( + id="6762f2d81bb69f9f2193bc54", + ) + ], + ) + """ + _response = self._raw_client.enqueue_create_ticket( + ticket_type_id=ticket_type_id, + contacts=contacts, + skip_notifications=skip_notifications, + conversation_to_link_id=conversation_to_link_id, + company_id=company_id, + created_at=created_at, + assignment=assignment, request_options=request_options, ) return _response.data - def get(self, ticket_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Ticket: + def get( + self, ticket_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> typing.Optional[Ticket]: """ You can fetch the details of a single ticket. @@ -158,7 +247,7 @@ def get(self, ticket_id: str, *, request_options: typing.Optional[RequestOptions Returns ------- - Ticket + typing.Optional[Ticket] Ticket found Examples @@ -180,13 +269,15 @@ def update( ticket_id: str, *, ticket_attributes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT, - state: typing.Optional[UpdateTicketRequestState] = OMIT, + ticket_state_id: typing.Optional[str] = OMIT, + company_id: typing.Optional[str] = OMIT, open: typing.Optional[bool] = OMIT, is_shared: typing.Optional[bool] = OMIT, snoozed_until: typing.Optional[int] = OMIT, - assignment: typing.Optional[UpdateTicketRequestAssignment] = OMIT, + admin_id: typing.Optional[int] = OMIT, + assignee_id: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> Ticket: + ) -> typing.Optional[Ticket]: """ You can update a ticket. @@ -198,8 +289,11 @@ def update( ticket_attributes : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] The attributes set on the ticket. - state : typing.Optional[UpdateTicketRequestState] - The state of the ticket. + ticket_state_id : typing.Optional[str] + The ID of the ticket state associated with the ticket type. + + company_id : typing.Optional[str] + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company. open : typing.Optional[bool] Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it. @@ -210,20 +304,23 @@ def update( snoozed_until : typing.Optional[int] The time you want the ticket to reopen. - assignment : typing.Optional[UpdateTicketRequestAssignment] + admin_id : typing.Optional[int] + The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins. + + assignee_id : typing.Optional[str] + The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - Ticket + typing.Optional[Ticket] Successful response Examples -------- from intercom import Intercom - from intercom.tickets import UpdateTicketRequestAssignment client = Intercom( token="YOUR_TOKEN", @@ -234,34 +331,67 @@ def update( "_default_title_": "example", "_default_description_": "there is a problem", }, - state="in_progress", + ticket_state_id="123", open=True, snoozed_until=1673609604, - assignment=UpdateTicketRequestAssignment( - admin_id="991267883", - assignee_id="991267885", - ), + admin_id=991268011, + assignee_id="123", ) """ _response = self._raw_client.update( ticket_id, ticket_attributes=ticket_attributes, - state=state, + ticket_state_id=ticket_state_id, + company_id=company_id, open=open, is_shared=is_shared, snoozed_until=snoozed_until, - assignment=assignment, + admin_id=admin_id, + assignee_id=assignee_id, request_options=request_options, ) return _response.data + def delete_ticket( + self, ticket_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteTicketResponse: + """ + You can delete a ticket using the Intercom provided ID. + + Parameters + ---------- + ticket_id : str + The unique identifier for the ticket which is given by Intercom. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteTicketResponse + successful + + Examples + -------- + from intercom import Intercom + + client = Intercom( + token="YOUR_TOKEN", + ) + client.tickets.delete_ticket( + ticket_id="ticket_id", + ) + """ + _response = self._raw_client.delete_ticket(ticket_id, request_options=request_options) + return _response.data + def search( self, *, query: SearchRequestQuery, pagination: typing.Optional[StartingAfterPaging] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> SyncPager[Ticket]: + ) -> SyncPager[typing.Optional[Ticket]]: """ You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. @@ -285,6 +415,7 @@ def search( ### 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"`). + The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. | Field | Type | | :---------------------------------------- | :--------------------------------------------------------------------------------------- | @@ -304,6 +435,13 @@ def search( | snoozed_until | Date (UNIX timestamp) | | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + {% admonition type="info" name="Searching by Category" %} + When searching for tickets by the **`category`** field, specific terms must be used instead of the category names: + * For **Customer** category tickets, use the term `request`. + * For **Back-office** category tickets, use the term `task`. + * For **Tracker** category tickets, use the term `tracker`. + {% /admonition %} + ### Accepted Operators {% admonition type="info" name="Searching based on `created_at`" %} @@ -336,7 +474,7 @@ def search( Returns ------- - SyncPager[Ticket] + SyncPager[typing.Optional[Ticket]] successful Examples @@ -412,7 +550,7 @@ async def reply( Returns ------- TicketReply - Admin quick_reply reply + Admin Reply to send Quick Reply Options Examples -------- @@ -430,7 +568,7 @@ async def main() -> None: ticket_id="123", request=ContactReplyTicketIntercomUserIdRequest( body="Thanks again :)", - intercom_user_id="667d619d8a68186f43bafe82", + intercom_user_id="6762f2971bb69f9f2193bc49", ), ) @@ -445,11 +583,13 @@ async def create( *, ticket_type_id: str, contacts: typing.Sequence[CreateTicketRequestContactsItem], + skip_notifications: typing.Optional[bool] = OMIT, + conversation_to_link_id: typing.Optional[str] = OMIT, company_id: typing.Optional[str] = OMIT, created_at: typing.Optional[int] = OMIT, - ticket_attributes: typing.Optional[TicketRequestCustomAttributes] = OMIT, + assignment: typing.Optional[CreateTicketRequestAssignment] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> Ticket: + ) -> typing.Optional[Ticket]: """ You can create a new ticket. @@ -461,20 +601,30 @@ async def create( contacts : typing.Sequence[CreateTicketRequestContactsItem] The list of contacts (users or leads) affected by this ticket. Currently only one is allowed + skip_notifications : typing.Optional[bool] + Option to disable notifications when a Ticket is created. + + conversation_to_link_id : typing.Optional[str] + The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets: + - conversation | back-office ticket + - customer tickets | non-shared back-office ticket + - conversation | tracker ticket + - customer ticket | tracker ticket + company_id : typing.Optional[str] - The ID of the company that the ticket is associated with. The ID that you set upon company creation. + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom created_at : typing.Optional[int] The time the ticket was created. If not provided, the current time will be used. - ticket_attributes : typing.Optional[TicketRequestCustomAttributes] + assignment : typing.Optional[CreateTicketRequestAssignment] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - Ticket + typing.Optional[Ticket] Successful response Examples @@ -493,13 +643,9 @@ async def main() -> None: ticket_type_id="1234", contacts=[ CreateTicketRequestContactsItemId( - id="667d61b78a68186f43bafe8d", + id="6762f2d81bb69f9f2193bc54", ) ], - ticket_attributes={ - "_default_title_": "example", - "_default_description_": "there is a problem", - }, ) @@ -508,14 +654,103 @@ async def main() -> None: _response = await self._raw_client.create( ticket_type_id=ticket_type_id, contacts=contacts, + skip_notifications=skip_notifications, + conversation_to_link_id=conversation_to_link_id, company_id=company_id, created_at=created_at, - ticket_attributes=ticket_attributes, + assignment=assignment, request_options=request_options, ) return _response.data - async def get(self, ticket_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Ticket: + async def enqueue_create_ticket( + self, + *, + ticket_type_id: str, + contacts: typing.Sequence[CreateTicketRequestContactsItem], + skip_notifications: typing.Optional[bool] = OMIT, + conversation_to_link_id: typing.Optional[str] = OMIT, + company_id: typing.Optional[str] = OMIT, + created_at: typing.Optional[int] = OMIT, + assignment: typing.Optional[CreateTicketRequestAssignment] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> Jobs: + """ + Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + + Parameters + ---------- + ticket_type_id : str + The ID of the type of ticket you want to create + + contacts : typing.Sequence[CreateTicketRequestContactsItem] + The list of contacts (users or leads) affected by this ticket. Currently only one is allowed + + skip_notifications : typing.Optional[bool] + Option to disable notifications when a Ticket is created. + + conversation_to_link_id : typing.Optional[str] + The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets: + - conversation | back-office ticket + - customer tickets | non-shared back-office ticket + - conversation | tracker ticket + - customer ticket | tracker ticket + + company_id : typing.Optional[str] + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom + + created_at : typing.Optional[int] + The time the ticket was created. If not provided, the current time will be used. + + assignment : typing.Optional[CreateTicketRequestAssignment] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + Jobs + Successful response + + Examples + -------- + import asyncio + + from intercom import AsyncIntercom, CreateTicketRequestContactsItemId + + client = AsyncIntercom( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.tickets.enqueue_create_ticket( + ticket_type_id="1234", + contacts=[ + CreateTicketRequestContactsItemId( + id="6762f2d81bb69f9f2193bc54", + ) + ], + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.enqueue_create_ticket( + ticket_type_id=ticket_type_id, + contacts=contacts, + skip_notifications=skip_notifications, + conversation_to_link_id=conversation_to_link_id, + company_id=company_id, + created_at=created_at, + assignment=assignment, + request_options=request_options, + ) + return _response.data + + async def get( + self, ticket_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> typing.Optional[Ticket]: """ You can fetch the details of a single ticket. @@ -529,7 +764,7 @@ async def get(self, ticket_id: str, *, request_options: typing.Optional[RequestO Returns ------- - Ticket + typing.Optional[Ticket] Ticket found Examples @@ -559,13 +794,15 @@ async def update( ticket_id: str, *, ticket_attributes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT, - state: typing.Optional[UpdateTicketRequestState] = OMIT, + ticket_state_id: typing.Optional[str] = OMIT, + company_id: typing.Optional[str] = OMIT, open: typing.Optional[bool] = OMIT, is_shared: typing.Optional[bool] = OMIT, snoozed_until: typing.Optional[int] = OMIT, - assignment: typing.Optional[UpdateTicketRequestAssignment] = OMIT, + admin_id: typing.Optional[int] = OMIT, + assignee_id: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> Ticket: + ) -> typing.Optional[Ticket]: """ You can update a ticket. @@ -577,8 +814,11 @@ async def update( ticket_attributes : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] The attributes set on the ticket. - state : typing.Optional[UpdateTicketRequestState] - The state of the ticket. + ticket_state_id : typing.Optional[str] + The ID of the ticket state associated with the ticket type. + + company_id : typing.Optional[str] + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company. open : typing.Optional[bool] Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it. @@ -589,14 +829,18 @@ async def update( snoozed_until : typing.Optional[int] The time you want the ticket to reopen. - assignment : typing.Optional[UpdateTicketRequestAssignment] + admin_id : typing.Optional[int] + The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins. + + assignee_id : typing.Optional[str] + The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - Ticket + typing.Optional[Ticket] Successful response Examples @@ -604,7 +848,6 @@ async def update( import asyncio from intercom import AsyncIntercom - from intercom.tickets import UpdateTicketRequestAssignment client = AsyncIntercom( token="YOUR_TOKEN", @@ -618,13 +861,11 @@ async def main() -> None: "_default_title_": "example", "_default_description_": "there is a problem", }, - state="in_progress", + ticket_state_id="123", open=True, snoozed_until=1673609604, - assignment=UpdateTicketRequestAssignment( - admin_id="991267883", - assignee_id="991267885", - ), + admin_id=991268011, + assignee_id="123", ) @@ -633,22 +874,65 @@ async def main() -> None: _response = await self._raw_client.update( ticket_id, ticket_attributes=ticket_attributes, - state=state, + ticket_state_id=ticket_state_id, + company_id=company_id, open=open, is_shared=is_shared, snoozed_until=snoozed_until, - assignment=assignment, + admin_id=admin_id, + assignee_id=assignee_id, request_options=request_options, ) return _response.data + async def delete_ticket( + self, ticket_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeleteTicketResponse: + """ + You can delete a ticket using the Intercom provided ID. + + Parameters + ---------- + ticket_id : str + The unique identifier for the ticket which is given by Intercom. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + DeleteTicketResponse + successful + + Examples + -------- + import asyncio + + from intercom import AsyncIntercom + + client = AsyncIntercom( + token="YOUR_TOKEN", + ) + + + async def main() -> None: + await client.tickets.delete_ticket( + ticket_id="ticket_id", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.delete_ticket(ticket_id, request_options=request_options) + return _response.data + async def search( self, *, query: SearchRequestQuery, pagination: typing.Optional[StartingAfterPaging] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> AsyncPager[Ticket]: + ) -> AsyncPager[typing.Optional[Ticket]]: """ You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. @@ -672,6 +956,7 @@ async def search( ### 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"`). + The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. | Field | Type | | :---------------------------------------- | :--------------------------------------------------------------------------------------- | @@ -691,6 +976,13 @@ async def search( | snoozed_until | Date (UNIX timestamp) | | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + {% admonition type="info" name="Searching by Category" %} + When searching for tickets by the **`category`** field, specific terms must be used instead of the category names: + * For **Customer** category tickets, use the term `request`. + * For **Back-office** category tickets, use the term `task`. + * For **Tracker** category tickets, use the term `tracker`. + {% /admonition %} + ### Accepted Operators {% admonition type="info" name="Searching based on `created_at`" %} @@ -723,7 +1015,7 @@ async def search( Returns ------- - AsyncPager[Ticket] + AsyncPager[typing.Optional[Ticket]] successful Examples diff --git a/src/intercom/tickets/raw_client.py b/src/intercom/tickets/raw_client.py index 1a604dc..d5e4264 100644 --- a/src/intercom/tickets/raw_client.py +++ b/src/intercom/tickets/raw_client.py @@ -14,17 +14,17 @@ from ..errors.bad_request_error import BadRequestError from ..errors.not_found_error import NotFoundError from ..errors.unauthorized_error import UnauthorizedError +from ..jobs.types.jobs import Jobs +from ..types.create_ticket_request_assignment import CreateTicketRequestAssignment from ..types.create_ticket_request_contacts_item import CreateTicketRequestContactsItem from ..types.error import Error from ..types.search_request_query import SearchRequestQuery from ..types.starting_after_paging import StartingAfterPaging from ..types.ticket_list import TicketList from ..types.ticket_reply import TicketReply -from ..types.ticket_request_custom_attributes import TicketRequestCustomAttributes +from .types.delete_ticket_response import DeleteTicketResponse from .types.ticket import Ticket from .types.tickets_reply_request_body import TicketsReplyRequestBody -from .types.update_ticket_request_assignment import UpdateTicketRequestAssignment -from .types.update_ticket_request_state import UpdateTicketRequestState # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -56,7 +56,7 @@ def reply( Returns ------- HttpResponse[TicketReply] - Admin quick_reply reply + Admin Reply to send Quick Reply Options """ _response = self._client_wrapper.httpx_client.request( f"tickets/{jsonable_encoder(ticket_id)}/reply", @@ -123,11 +123,13 @@ def create( *, ticket_type_id: str, contacts: typing.Sequence[CreateTicketRequestContactsItem], + skip_notifications: typing.Optional[bool] = OMIT, + conversation_to_link_id: typing.Optional[str] = OMIT, company_id: typing.Optional[str] = OMIT, created_at: typing.Optional[int] = OMIT, - ticket_attributes: typing.Optional[TicketRequestCustomAttributes] = OMIT, + assignment: typing.Optional[CreateTicketRequestAssignment] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> HttpResponse[Ticket]: + ) -> HttpResponse[typing.Optional[Ticket]]: """ You can create a new ticket. @@ -139,33 +141,47 @@ def create( contacts : typing.Sequence[CreateTicketRequestContactsItem] The list of contacts (users or leads) affected by this ticket. Currently only one is allowed + skip_notifications : typing.Optional[bool] + Option to disable notifications when a Ticket is created. + + conversation_to_link_id : typing.Optional[str] + The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets: + - conversation | back-office ticket + - customer tickets | non-shared back-office ticket + - conversation | tracker ticket + - customer ticket | tracker ticket + company_id : typing.Optional[str] - The ID of the company that the ticket is associated with. The ID that you set upon company creation. + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom created_at : typing.Optional[int] The time the ticket was created. If not provided, the current time will be used. - ticket_attributes : typing.Optional[TicketRequestCustomAttributes] + assignment : typing.Optional[CreateTicketRequestAssignment] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - HttpResponse[Ticket] + HttpResponse[typing.Optional[Ticket]] Successful response """ _response = self._client_wrapper.httpx_client.request( "tickets", method="POST", json={ + "skip_notifications": skip_notifications, "ticket_type_id": ticket_type_id, "contacts": convert_and_respect_annotation_metadata( object_=contacts, annotation=typing.Sequence[CreateTicketRequestContactsItem], direction="write" ), + "conversation_to_link_id": conversation_to_link_id, "company_id": company_id, "created_at": created_at, - "ticket_attributes": ticket_attributes, + "assignment": convert_and_respect_annotation_metadata( + object_=assignment, annotation=CreateTicketRequestAssignment, direction="write" + ), }, headers={ "content-type": "application/json", @@ -174,11 +190,13 @@ def create( omit=OMIT, ) try: + if _response is None or not _response.text.strip(): + return HttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - Ticket, + typing.Optional[Ticket], construct_type( - type_=Ticket, # type: ignore + type_=typing.Optional[Ticket], # type: ignore object_=_response.json(), ), ) @@ -199,7 +217,117 @@ def create( raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) - def get(self, ticket_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Ticket]: + def enqueue_create_ticket( + self, + *, + ticket_type_id: str, + contacts: typing.Sequence[CreateTicketRequestContactsItem], + skip_notifications: typing.Optional[bool] = OMIT, + conversation_to_link_id: typing.Optional[str] = OMIT, + company_id: typing.Optional[str] = OMIT, + created_at: typing.Optional[int] = OMIT, + assignment: typing.Optional[CreateTicketRequestAssignment] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Jobs]: + """ + Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + + Parameters + ---------- + ticket_type_id : str + The ID of the type of ticket you want to create + + contacts : typing.Sequence[CreateTicketRequestContactsItem] + The list of contacts (users or leads) affected by this ticket. Currently only one is allowed + + skip_notifications : typing.Optional[bool] + Option to disable notifications when a Ticket is created. + + conversation_to_link_id : typing.Optional[str] + The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets: + - conversation | back-office ticket + - customer tickets | non-shared back-office ticket + - conversation | tracker ticket + - customer ticket | tracker ticket + + company_id : typing.Optional[str] + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom + + created_at : typing.Optional[int] + The time the ticket was created. If not provided, the current time will be used. + + assignment : typing.Optional[CreateTicketRequestAssignment] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Jobs] + Successful response + """ + _response = self._client_wrapper.httpx_client.request( + "tickets/enqueue", + method="POST", + json={ + "skip_notifications": skip_notifications, + "ticket_type_id": ticket_type_id, + "contacts": convert_and_respect_annotation_metadata( + object_=contacts, annotation=typing.Sequence[CreateTicketRequestContactsItem], direction="write" + ), + "conversation_to_link_id": conversation_to_link_id, + "company_id": company_id, + "created_at": created_at, + "assignment": convert_and_respect_annotation_metadata( + object_=assignment, annotation=CreateTicketRequestAssignment, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Jobs, + construct_type( + type_=Jobs, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + construct_type( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + construct_type( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get( + self, ticket_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[typing.Optional[Ticket]]: """ You can fetch the details of a single ticket. @@ -213,7 +341,7 @@ def get(self, ticket_id: str, *, request_options: typing.Optional[RequestOptions Returns ------- - HttpResponse[Ticket] + HttpResponse[typing.Optional[Ticket]] Ticket found """ _response = self._client_wrapper.httpx_client.request( @@ -222,11 +350,13 @@ def get(self, ticket_id: str, *, request_options: typing.Optional[RequestOptions request_options=request_options, ) try: + if _response is None or not _response.text.strip(): + return HttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - Ticket, + typing.Optional[Ticket], construct_type( - type_=Ticket, # type: ignore + type_=typing.Optional[Ticket], # type: ignore object_=_response.json(), ), ) @@ -252,13 +382,15 @@ def update( ticket_id: str, *, ticket_attributes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT, - state: typing.Optional[UpdateTicketRequestState] = OMIT, + ticket_state_id: typing.Optional[str] = OMIT, + company_id: typing.Optional[str] = OMIT, open: typing.Optional[bool] = OMIT, is_shared: typing.Optional[bool] = OMIT, snoozed_until: typing.Optional[int] = OMIT, - assignment: typing.Optional[UpdateTicketRequestAssignment] = OMIT, + admin_id: typing.Optional[int] = OMIT, + assignee_id: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> HttpResponse[Ticket]: + ) -> HttpResponse[typing.Optional[Ticket]]: """ You can update a ticket. @@ -270,8 +402,11 @@ def update( ticket_attributes : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] The attributes set on the ticket. - state : typing.Optional[UpdateTicketRequestState] - The state of the ticket. + ticket_state_id : typing.Optional[str] + The ID of the ticket state associated with the ticket type. + + company_id : typing.Optional[str] + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company. open : typing.Optional[bool] Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it. @@ -282,14 +417,18 @@ def update( snoozed_until : typing.Optional[int] The time you want the ticket to reopen. - assignment : typing.Optional[UpdateTicketRequestAssignment] + admin_id : typing.Optional[int] + The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins. + + assignee_id : typing.Optional[str] + The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - HttpResponse[Ticket] + HttpResponse[typing.Optional[Ticket]] Successful response """ _response = self._client_wrapper.httpx_client.request( @@ -297,13 +436,13 @@ def update( method="PUT", json={ "ticket_attributes": ticket_attributes, - "state": state, + "ticket_state_id": ticket_state_id, + "company_id": company_id, "open": open, "is_shared": is_shared, "snoozed_until": snoozed_until, - "assignment": convert_and_respect_annotation_metadata( - object_=assignment, annotation=UpdateTicketRequestAssignment, direction="write" - ), + "admin_id": admin_id, + "assignee_id": assignee_id, }, headers={ "content-type": "application/json", @@ -311,12 +450,86 @@ def update( request_options=request_options, omit=OMIT, ) + try: + if _response is None or not _response.text.strip(): + return HttpResponse(response=_response, data=None) + if 200 <= _response.status_code < 300: + _data = typing.cast( + typing.Optional[Ticket], + construct_type( + type_=typing.Optional[Ticket], # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + construct_type( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + construct_type( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + construct_type( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete_ticket( + self, ticket_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[DeleteTicketResponse]: + """ + You can delete a ticket using the Intercom provided ID. + + Parameters + ---------- + ticket_id : str + The unique identifier for the ticket which is given by Intercom. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[DeleteTicketResponse] + successful + """ + _response = self._client_wrapper.httpx_client.request( + f"tickets/{jsonable_encoder(ticket_id)}", + method="DELETE", + request_options=request_options, + ) try: if 200 <= _response.status_code < 300: _data = typing.cast( - Ticket, + DeleteTicketResponse, construct_type( - type_=Ticket, # type: ignore + type_=DeleteTicketResponse, # type: ignore object_=_response.json(), ), ) @@ -354,7 +567,7 @@ def search( query: SearchRequestQuery, pagination: typing.Optional[StartingAfterPaging] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> SyncPager[Ticket]: + ) -> SyncPager[typing.Optional[Ticket]]: """ You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. @@ -378,6 +591,7 @@ def search( ### 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"`). + The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. | Field | Type | | :---------------------------------------- | :--------------------------------------------------------------------------------------- | @@ -397,6 +611,13 @@ def search( | snoozed_until | Date (UNIX timestamp) | | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + {% admonition type="info" name="Searching by Category" %} + When searching for tickets by the **`category`** field, specific terms must be used instead of the category names: + * For **Customer** category tickets, use the term `request`. + * For **Back-office** category tickets, use the term `task`. + * For **Tracker** category tickets, use the term `tracker`. + {% /admonition %} + ### Accepted Operators {% admonition type="info" name="Searching based on `created_at`" %} @@ -429,7 +650,7 @@ def search( Returns ------- - SyncPager[Ticket] + SyncPager[typing.Optional[Ticket]] successful """ _response = self._client_wrapper.httpx_client.request( @@ -504,7 +725,7 @@ async def reply( Returns ------- AsyncHttpResponse[TicketReply] - Admin quick_reply reply + Admin Reply to send Quick Reply Options """ _response = await self._client_wrapper.httpx_client.request( f"tickets/{jsonable_encoder(ticket_id)}/reply", @@ -571,11 +792,13 @@ async def create( *, ticket_type_id: str, contacts: typing.Sequence[CreateTicketRequestContactsItem], + skip_notifications: typing.Optional[bool] = OMIT, + conversation_to_link_id: typing.Optional[str] = OMIT, company_id: typing.Optional[str] = OMIT, created_at: typing.Optional[int] = OMIT, - ticket_attributes: typing.Optional[TicketRequestCustomAttributes] = OMIT, + assignment: typing.Optional[CreateTicketRequestAssignment] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> AsyncHttpResponse[Ticket]: + ) -> AsyncHttpResponse[typing.Optional[Ticket]]: """ You can create a new ticket. @@ -587,33 +810,146 @@ async def create( contacts : typing.Sequence[CreateTicketRequestContactsItem] The list of contacts (users or leads) affected by this ticket. Currently only one is allowed + skip_notifications : typing.Optional[bool] + Option to disable notifications when a Ticket is created. + + conversation_to_link_id : typing.Optional[str] + The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets: + - conversation | back-office ticket + - customer tickets | non-shared back-office ticket + - conversation | tracker ticket + - customer ticket | tracker ticket + company_id : typing.Optional[str] - The ID of the company that the ticket is associated with. The ID that you set upon company creation. + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom created_at : typing.Optional[int] The time the ticket was created. If not provided, the current time will be used. - ticket_attributes : typing.Optional[TicketRequestCustomAttributes] + assignment : typing.Optional[CreateTicketRequestAssignment] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - AsyncHttpResponse[Ticket] + AsyncHttpResponse[typing.Optional[Ticket]] Successful response """ _response = await self._client_wrapper.httpx_client.request( "tickets", method="POST", json={ + "skip_notifications": skip_notifications, "ticket_type_id": ticket_type_id, "contacts": convert_and_respect_annotation_metadata( object_=contacts, annotation=typing.Sequence[CreateTicketRequestContactsItem], direction="write" ), + "conversation_to_link_id": conversation_to_link_id, "company_id": company_id, "created_at": created_at, - "ticket_attributes": ticket_attributes, + "assignment": convert_and_respect_annotation_metadata( + object_=assignment, annotation=CreateTicketRequestAssignment, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if _response is None or not _response.text.strip(): + return AsyncHttpResponse(response=_response, data=None) + if 200 <= _response.status_code < 300: + _data = typing.cast( + typing.Optional[Ticket], + construct_type( + type_=typing.Optional[Ticket], # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + construct_type( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def enqueue_create_ticket( + self, + *, + ticket_type_id: str, + contacts: typing.Sequence[CreateTicketRequestContactsItem], + skip_notifications: typing.Optional[bool] = OMIT, + conversation_to_link_id: typing.Optional[str] = OMIT, + company_id: typing.Optional[str] = OMIT, + created_at: typing.Optional[int] = OMIT, + assignment: typing.Optional[CreateTicketRequestAssignment] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Jobs]: + """ + Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + + Parameters + ---------- + ticket_type_id : str + The ID of the type of ticket you want to create + + contacts : typing.Sequence[CreateTicketRequestContactsItem] + The list of contacts (users or leads) affected by this ticket. Currently only one is allowed + + skip_notifications : typing.Optional[bool] + Option to disable notifications when a Ticket is created. + + conversation_to_link_id : typing.Optional[str] + The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets: + - conversation | back-office ticket + - customer tickets | non-shared back-office ticket + - conversation | tracker ticket + - customer ticket | tracker ticket + + company_id : typing.Optional[str] + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom + + created_at : typing.Optional[int] + The time the ticket was created. If not provided, the current time will be used. + + assignment : typing.Optional[CreateTicketRequestAssignment] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Jobs] + Successful response + """ + _response = await self._client_wrapper.httpx_client.request( + "tickets/enqueue", + method="POST", + json={ + "skip_notifications": skip_notifications, + "ticket_type_id": ticket_type_id, + "contacts": convert_and_respect_annotation_metadata( + object_=contacts, annotation=typing.Sequence[CreateTicketRequestContactsItem], direction="write" + ), + "conversation_to_link_id": conversation_to_link_id, + "company_id": company_id, + "created_at": created_at, + "assignment": convert_and_respect_annotation_metadata( + object_=assignment, annotation=CreateTicketRequestAssignment, direction="write" + ), }, headers={ "content-type": "application/json", @@ -624,13 +960,24 @@ async def create( try: if 200 <= _response.status_code < 300: _data = typing.cast( - Ticket, + Jobs, construct_type( - type_=Ticket, # type: ignore + type_=Jobs, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + construct_type( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) if _response.status_code == 401: raise UnauthorizedError( headers=dict(_response.headers), @@ -649,7 +996,7 @@ async def create( async def get( self, ticket_id: str, *, request_options: typing.Optional[RequestOptions] = None - ) -> AsyncHttpResponse[Ticket]: + ) -> AsyncHttpResponse[typing.Optional[Ticket]]: """ You can fetch the details of a single ticket. @@ -663,7 +1010,7 @@ async def get( Returns ------- - AsyncHttpResponse[Ticket] + AsyncHttpResponse[typing.Optional[Ticket]] Ticket found """ _response = await self._client_wrapper.httpx_client.request( @@ -672,11 +1019,13 @@ async def get( request_options=request_options, ) try: + if _response is None or not _response.text.strip(): + return AsyncHttpResponse(response=_response, data=None) if 200 <= _response.status_code < 300: _data = typing.cast( - Ticket, + typing.Optional[Ticket], construct_type( - type_=Ticket, # type: ignore + type_=typing.Optional[Ticket], # type: ignore object_=_response.json(), ), ) @@ -702,13 +1051,15 @@ async def update( ticket_id: str, *, ticket_attributes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT, - state: typing.Optional[UpdateTicketRequestState] = OMIT, + ticket_state_id: typing.Optional[str] = OMIT, + company_id: typing.Optional[str] = OMIT, open: typing.Optional[bool] = OMIT, is_shared: typing.Optional[bool] = OMIT, snoozed_until: typing.Optional[int] = OMIT, - assignment: typing.Optional[UpdateTicketRequestAssignment] = OMIT, + admin_id: typing.Optional[int] = OMIT, + assignee_id: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> AsyncHttpResponse[Ticket]: + ) -> AsyncHttpResponse[typing.Optional[Ticket]]: """ You can update a ticket. @@ -720,8 +1071,11 @@ async def update( ticket_attributes : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] The attributes set on the ticket. - state : typing.Optional[UpdateTicketRequestState] - The state of the ticket. + ticket_state_id : typing.Optional[str] + The ID of the ticket state associated with the ticket type. + + company_id : typing.Optional[str] + The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company. open : typing.Optional[bool] Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it. @@ -732,14 +1086,18 @@ async def update( snoozed_until : typing.Optional[int] The time you want the ticket to reopen. - assignment : typing.Optional[UpdateTicketRequestAssignment] + admin_id : typing.Optional[int] + The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins. + + assignee_id : typing.Optional[str] + The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - AsyncHttpResponse[Ticket] + AsyncHttpResponse[typing.Optional[Ticket]] Successful response """ _response = await self._client_wrapper.httpx_client.request( @@ -747,13 +1105,13 @@ async def update( method="PUT", json={ "ticket_attributes": ticket_attributes, - "state": state, + "ticket_state_id": ticket_state_id, + "company_id": company_id, "open": open, "is_shared": is_shared, "snoozed_until": snoozed_until, - "assignment": convert_and_respect_annotation_metadata( - object_=assignment, annotation=UpdateTicketRequestAssignment, direction="write" - ), + "admin_id": admin_id, + "assignee_id": assignee_id, }, headers={ "content-type": "application/json", @@ -761,12 +1119,86 @@ async def update( request_options=request_options, omit=OMIT, ) + try: + if _response is None or not _response.text.strip(): + return AsyncHttpResponse(response=_response, data=None) + if 200 <= _response.status_code < 300: + _data = typing.cast( + typing.Optional[Ticket], + construct_type( + type_=typing.Optional[Ticket], # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + construct_type( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + construct_type( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + construct_type( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete_ticket( + self, ticket_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[DeleteTicketResponse]: + """ + You can delete a ticket using the Intercom provided ID. + + Parameters + ---------- + ticket_id : str + The unique identifier for the ticket which is given by Intercom. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[DeleteTicketResponse] + successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"tickets/{jsonable_encoder(ticket_id)}", + method="DELETE", + request_options=request_options, + ) try: if 200 <= _response.status_code < 300: _data = typing.cast( - Ticket, + DeleteTicketResponse, construct_type( - type_=Ticket, # type: ignore + type_=DeleteTicketResponse, # type: ignore object_=_response.json(), ), ) @@ -804,7 +1236,7 @@ async def search( query: SearchRequestQuery, pagination: typing.Optional[StartingAfterPaging] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> AsyncPager[Ticket]: + ) -> AsyncPager[typing.Optional[Ticket]]: """ You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. @@ -828,6 +1260,7 @@ async def search( ### 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"`). + The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. | Field | Type | | :---------------------------------------- | :--------------------------------------------------------------------------------------- | @@ -847,6 +1280,13 @@ async def search( | snoozed_until | Date (UNIX timestamp) | | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + {% admonition type="info" name="Searching by Category" %} + When searching for tickets by the **`category`** field, specific terms must be used instead of the category names: + * For **Customer** category tickets, use the term `request`. + * For **Back-office** category tickets, use the term `task`. + * For **Tracker** category tickets, use the term `tracker`. + {% /admonition %} + ### Accepted Operators {% admonition type="info" name="Searching based on `created_at`" %} @@ -879,7 +1319,7 @@ async def search( Returns ------- - AsyncPager[Ticket] + AsyncPager[typing.Optional[Ticket]] successful """ _response = await self._client_wrapper.httpx_client.request( diff --git a/src/intercom/tickets/types/__init__.py b/src/intercom/tickets/types/__init__.py index c28b527..8e89c14 100644 --- a/src/intercom/tickets/types/__init__.py +++ b/src/intercom/tickets/types/__init__.py @@ -2,30 +2,48 @@ # isort: skip_file +from .delete_ticket_response import DeleteTicketResponse from .ticket import Ticket from .ticket_category import TicketCategory from .ticket_contacts import TicketContacts from .ticket_part import TicketPart from .ticket_part_previous_ticket_state import TicketPartPreviousTicketState from .ticket_part_ticket_state import TicketPartTicketState -from .ticket_ticket_state import TicketTicketState +from .ticket_part_updated_attribute_data import TicketPartUpdatedAttributeData +from .ticket_part_updated_attribute_data_attribute import TicketPartUpdatedAttributeDataAttribute +from .ticket_part_updated_attribute_data_value import TicketPartUpdatedAttributeDataValue +from .ticket_part_updated_attribute_data_value_id import TicketPartUpdatedAttributeDataValueId +from .ticket_part_updated_attribute_data_value_label import TicketPartUpdatedAttributeDataValueLabel +from .ticket_state import TicketState +from .ticket_state_category import TicketStateCategory +from .ticket_state_detailed import TicketStateDetailed +from .ticket_state_detailed_category import TicketStateDetailedCategory +from .ticket_state_detailed_ticket_types import TicketStateDetailedTicketTypes from .ticket_type import TicketType from .ticket_type_category import TicketTypeCategory +from .ticket_type_ticket_states import TicketTypeTicketStates from .tickets_reply_request_body import TicketsReplyRequestBody -from .update_ticket_request_assignment import UpdateTicketRequestAssignment -from .update_ticket_request_state import UpdateTicketRequestState __all__ = [ + "DeleteTicketResponse", "Ticket", "TicketCategory", "TicketContacts", "TicketPart", "TicketPartPreviousTicketState", "TicketPartTicketState", - "TicketTicketState", + "TicketPartUpdatedAttributeData", + "TicketPartUpdatedAttributeDataAttribute", + "TicketPartUpdatedAttributeDataValue", + "TicketPartUpdatedAttributeDataValueId", + "TicketPartUpdatedAttributeDataValueLabel", + "TicketState", + "TicketStateCategory", + "TicketStateDetailed", + "TicketStateDetailedCategory", + "TicketStateDetailedTicketTypes", "TicketType", "TicketTypeCategory", + "TicketTypeTicketStates", "TicketsReplyRequestBody", - "UpdateTicketRequestAssignment", - "UpdateTicketRequestState", ] diff --git a/src/intercom/tickets/types/delete_ticket_response.py b/src/intercom/tickets/types/delete_ticket_response.py new file mode 100644 index 0000000..4b748b1 --- /dev/null +++ b/src/intercom/tickets/types/delete_ticket_response.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ...core.pydantic_utilities import IS_PYDANTIC_V2 +from ...core.unchecked_base_model import UncheckedBaseModel + + +class DeleteTicketResponse(UncheckedBaseModel): + """ + Response when a ticket is deleted. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier for the ticket. + """ + + object: typing.Optional[typing.Literal["ticket"]] = pydantic.Field(default=None) + """ + always ticket + """ + + deleted: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the ticket is deleted or not. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/intercom/tickets/types/ticket.py b/src/intercom/tickets/types/ticket.py index a7e72bb..eca715f 100644 --- a/src/intercom/tickets/types/ticket.py +++ b/src/intercom/tickets/types/ticket.py @@ -10,7 +10,7 @@ from ...types.ticket_parts import TicketParts from .ticket_category import TicketCategory from .ticket_contacts import TicketContacts -from .ticket_ticket_state import TicketTicketState +from .ticket_state import TicketState from .ticket_type import TicketType @@ -19,34 +19,30 @@ class Ticket(UncheckedBaseModel): Tickets are how you track requests from your users. """ - type: typing.Literal["ticket"] = pydantic.Field(default="ticket") + type: typing.Optional[typing.Literal["ticket"]] = pydantic.Field(default=None) """ Always ticket """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The unique identifier for the ticket which is given by Intercom. """ - ticket_id: str = pydantic.Field() + ticket_id: typing.Optional[str] = pydantic.Field(default=None) """ The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries. """ - category: TicketCategory = pydantic.Field() + category: typing.Optional[TicketCategory] = pydantic.Field(default=None) """ Category of the Ticket. """ - ticket_attributes: TicketCustomAttributes - ticket_state: TicketTicketState = pydantic.Field() - """ - The state the ticket is currently in - """ - - ticket_type: TicketType - contacts: TicketContacts + ticket_attributes: typing.Optional[TicketCustomAttributes] = None + ticket_state: typing.Optional[TicketState] = None + ticket_type: typing.Optional[TicketType] = None + contacts: typing.Optional[TicketContacts] = None admin_assignee_id: typing.Optional[str] = pydantic.Field(default=None) """ The id representing the admin assigned to the ticket. @@ -84,16 +80,6 @@ class Ticket(UncheckedBaseModel): Whether or not the ticket is shared with the customer. """ - ticket_state_internal_label: typing.Optional[str] = pydantic.Field(default=None) - """ - The state the ticket is currently in, in a human readable form - visible in Intercom - """ - - ticket_state_external_label: typing.Optional[str] = pydantic.Field(default=None) - """ - The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal. - """ - if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 else: diff --git a/src/intercom/tickets/types/ticket_contacts.py b/src/intercom/tickets/types/ticket_contacts.py index 7a11c16..af0454d 100644 --- a/src/intercom/tickets/types/ticket_contacts.py +++ b/src/intercom/tickets/types/ticket_contacts.py @@ -13,12 +13,12 @@ class TicketContacts(UncheckedBaseModel): The list of contacts affected by a ticket. """ - type: typing.Literal["contact.list"] = pydantic.Field(default="contact.list") + type: typing.Optional[typing.Literal["contact.list"]] = pydantic.Field(default=None) """ always contact.list """ - contacts: typing.List[ContactReference] = pydantic.Field() + contacts: typing.Optional[typing.List[ContactReference]] = pydantic.Field(default=None) """ The list of contacts affected by this ticket. """ diff --git a/src/intercom/tickets/types/ticket_part.py b/src/intercom/tickets/types/ticket_part.py index 415a3a4..c6056e2 100644 --- a/src/intercom/tickets/types/ticket_part.py +++ b/src/intercom/tickets/types/ticket_part.py @@ -10,6 +10,7 @@ from ...types.ticket_part_author import TicketPartAuthor from .ticket_part_previous_ticket_state import TicketPartPreviousTicketState from .ticket_part_ticket_state import TicketPartTicketState +from .ticket_part_updated_attribute_data import TicketPartUpdatedAttributeData class TicketPart(UncheckedBaseModel): @@ -17,17 +18,17 @@ class TicketPart(UncheckedBaseModel): A Ticket Part represents a message in the ticket. """ - type: typing.Literal["ticket_part"] = pydantic.Field(default="ticket_part") + type: typing.Optional[str] = pydantic.Field(default=None) """ Always ticket_part """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The id representing the ticket part. """ - part_type: str = pydantic.Field() + part_type: typing.Optional[str] = pydantic.Field(default=None) """ The type of ticket part. """ @@ -42,12 +43,12 @@ class TicketPart(UncheckedBaseModel): The previous state of the ticket. """ - ticket_state: TicketPartTicketState = pydantic.Field() + ticket_state: typing.Optional[TicketPartTicketState] = pydantic.Field(default=None) """ The state of the ticket. """ - created_at: int = pydantic.Field() + created_at: typing.Optional[int] = pydantic.Field(default=None) """ The time the ticket part was created. """ @@ -78,6 +79,16 @@ class TicketPart(UncheckedBaseModel): Whether or not the ticket part has been redacted. """ + app_package_code: typing.Optional[str] = pydantic.Field(default=None) + """ + The app package code if this part was created via API. Note this field won't show if the part was not created via API. + """ + + updated_attribute_data: typing.Optional[TicketPartUpdatedAttributeData] = pydantic.Field(default=None) + """ + The updated attribute data of the ticket part. Only present for attribute update parts. + """ + if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 else: diff --git a/src/intercom/tickets/types/ticket_part_updated_attribute_data.py b/src/intercom/tickets/types/ticket_part_updated_attribute_data.py new file mode 100644 index 0000000..42980c0 --- /dev/null +++ b/src/intercom/tickets/types/ticket_part_updated_attribute_data.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ...core.pydantic_utilities import IS_PYDANTIC_V2 +from ...core.unchecked_base_model import UncheckedBaseModel +from .ticket_part_updated_attribute_data_attribute import TicketPartUpdatedAttributeDataAttribute +from .ticket_part_updated_attribute_data_value import TicketPartUpdatedAttributeDataValue + + +class TicketPartUpdatedAttributeData(UncheckedBaseModel): + """ + The updated attribute data of the ticket part. Only present for attribute update parts. + """ + + attribute: TicketPartUpdatedAttributeDataAttribute = pydantic.Field() + """ + Information about the attribute that was updated. + """ + + value: TicketPartUpdatedAttributeDataValue = pydantic.Field() + """ + The new value of the attribute. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/intercom/tickets/types/ticket_part_updated_attribute_data_attribute.py b/src/intercom/tickets/types/ticket_part_updated_attribute_data_attribute.py new file mode 100644 index 0000000..b7bd91e --- /dev/null +++ b/src/intercom/tickets/types/ticket_part_updated_attribute_data_attribute.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ...core.pydantic_utilities import IS_PYDANTIC_V2 +from ...core.unchecked_base_model import UncheckedBaseModel + + +class TicketPartUpdatedAttributeDataAttribute(UncheckedBaseModel): + """ + Information about the attribute that was updated. + """ + + type: typing.Literal["attribute"] = pydantic.Field(default="attribute") + """ + The type of the object. Always 'attribute'. + """ + + id: str = pydantic.Field() + """ + The unique identifier of the attribute. + """ + + label: str = pydantic.Field() + """ + The human-readable name of the attribute. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/intercom/tickets/types/ticket_part_updated_attribute_data_value.py b/src/intercom/tickets/types/ticket_part_updated_attribute_data_value.py new file mode 100644 index 0000000..9ea5c01 --- /dev/null +++ b/src/intercom/tickets/types/ticket_part_updated_attribute_data_value.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ...core.pydantic_utilities import IS_PYDANTIC_V2 +from ...core.unchecked_base_model import UncheckedBaseModel +from .ticket_part_updated_attribute_data_value_id import TicketPartUpdatedAttributeDataValueId +from .ticket_part_updated_attribute_data_value_label import TicketPartUpdatedAttributeDataValueLabel + + +class TicketPartUpdatedAttributeDataValue(UncheckedBaseModel): + """ + The new value of the attribute. + """ + + type: typing.Literal["value"] = pydantic.Field(default="value") + """ + The type of the object. Always 'value'. + """ + + id: TicketPartUpdatedAttributeDataValueId + label: TicketPartUpdatedAttributeDataValueLabel + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/intercom/tickets/types/ticket_part_updated_attribute_data_value_id.py b/src/intercom/tickets/types/ticket_part_updated_attribute_data_value_id.py new file mode 100644 index 0000000..01d2f9d --- /dev/null +++ b/src/intercom/tickets/types/ticket_part_updated_attribute_data_value_id.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TicketPartUpdatedAttributeDataValueId = typing.Union[typing.Optional[str], typing.List[int]] diff --git a/src/intercom/tickets/types/ticket_part_updated_attribute_data_value_label.py b/src/intercom/tickets/types/ticket_part_updated_attribute_data_value_label.py new file mode 100644 index 0000000..4026e8a --- /dev/null +++ b/src/intercom/tickets/types/ticket_part_updated_attribute_data_value_label.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TicketPartUpdatedAttributeDataValueLabel = typing.Union[str, typing.List[str]] diff --git a/src/intercom/tickets/types/ticket_state.py b/src/intercom/tickets/types/ticket_state.py new file mode 100644 index 0000000..6beb7dd --- /dev/null +++ b/src/intercom/tickets/types/ticket_state.py @@ -0,0 +1,48 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ...core.pydantic_utilities import IS_PYDANTIC_V2 +from ...core.unchecked_base_model import UncheckedBaseModel +from .ticket_state_category import TicketStateCategory + + +class TicketState(UncheckedBaseModel): + """ + A ticket state, used to define the state of a ticket. + """ + + type: typing.Optional[str] = pydantic.Field(default=None) + """ + String representing the object's type. Always has the value `ticket_state`. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The id of the ticket state + """ + + category: typing.Optional[TicketStateCategory] = pydantic.Field(default=None) + """ + The category of the ticket state + """ + + internal_label: typing.Optional[str] = pydantic.Field(default=None) + """ + The state the ticket is currently in, in a human readable form - visible in Intercom + """ + + external_label: typing.Optional[str] = pydantic.Field(default=None) + """ + The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/intercom/tickets/types/ticket_ticket_state.py b/src/intercom/tickets/types/ticket_state_category.py similarity index 83% rename from src/intercom/tickets/types/ticket_ticket_state.py rename to src/intercom/tickets/types/ticket_state_category.py index 0c384dd..d53c56a 100644 --- a/src/intercom/tickets/types/ticket_ticket_state.py +++ b/src/intercom/tickets/types/ticket_state_category.py @@ -2,6 +2,6 @@ import typing -TicketTicketState = typing.Union[ +TicketStateCategory = typing.Union[ typing.Literal["submitted", "in_progress", "waiting_on_customer", "resolved"], typing.Any ] diff --git a/src/intercom/tickets/types/ticket_state_detailed.py b/src/intercom/tickets/types/ticket_state_detailed.py new file mode 100644 index 0000000..973767f --- /dev/null +++ b/src/intercom/tickets/types/ticket_state_detailed.py @@ -0,0 +1,59 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ...core.pydantic_utilities import IS_PYDANTIC_V2 +from ...core.unchecked_base_model import UncheckedBaseModel +from .ticket_state_detailed_category import TicketStateDetailedCategory +from .ticket_state_detailed_ticket_types import TicketStateDetailedTicketTypes + + +class TicketStateDetailed(UncheckedBaseModel): + """ + A ticket state, used to define the state of a ticket. + """ + + type: typing.Optional[str] = pydantic.Field(default=None) + """ + String representing the object's type. Always has the value `ticket_state`. + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The id of the ticket state + """ + + category: typing.Optional[TicketStateDetailedCategory] = pydantic.Field(default=None) + """ + The category of the ticket state + """ + + internal_label: typing.Optional[str] = pydantic.Field(default=None) + """ + The state the ticket is currently in, in a human readable form - visible in Intercom + """ + + external_label: typing.Optional[str] = pydantic.Field(default=None) + """ + The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal. + """ + + archived: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the ticket state is archived + """ + + ticket_types: typing.Optional[TicketStateDetailedTicketTypes] = pydantic.Field(default=None) + """ + A list of ticket types associated with a given ticket state. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/intercom/tickets/types/ticket_state_detailed_category.py b/src/intercom/tickets/types/ticket_state_detailed_category.py new file mode 100644 index 0000000..d8426ec --- /dev/null +++ b/src/intercom/tickets/types/ticket_state_detailed_category.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +TicketStateDetailedCategory = typing.Union[ + typing.Literal["submitted", "in_progress", "waiting_on_customer", "resolved"], typing.Any +] diff --git a/src/intercom/tickets/types/ticket_state_detailed_ticket_types.py b/src/intercom/tickets/types/ticket_state_detailed_ticket_types.py new file mode 100644 index 0000000..4a5f143 --- /dev/null +++ b/src/intercom/tickets/types/ticket_state_detailed_ticket_types.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ...core.pydantic_utilities import IS_PYDANTIC_V2 +from ...core.unchecked_base_model import UncheckedBaseModel +from .ticket_type import TicketType + + +class TicketStateDetailedTicketTypes(UncheckedBaseModel): + """ + A list of ticket types associated with a given ticket state. + """ + + type: typing.Optional[str] = pydantic.Field(default=None) + """ + String representing the object's type. Always has the value `list`. + """ + + data: typing.Optional[typing.List[typing.Optional[TicketType]]] = pydantic.Field(default=None) + """ + A list of ticket type attributes associated with a given ticket type. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/intercom/tickets/types/ticket_type.py b/src/intercom/tickets/types/ticket_type.py index 6f92762..fef0d5a 100644 --- a/src/intercom/tickets/types/ticket_type.py +++ b/src/intercom/tickets/types/ticket_type.py @@ -7,6 +7,7 @@ from ...core.unchecked_base_model import UncheckedBaseModel from ...types.ticket_type_attribute_list import TicketTypeAttributeList from .ticket_type_category import TicketTypeCategory +from .ticket_type_ticket_states import TicketTypeTicketStates class TicketType(UncheckedBaseModel): @@ -14,48 +15,53 @@ class TicketType(UncheckedBaseModel): A ticket type, used to define the data fields to be captured in a ticket. """ - type: typing.Literal["ticket_type"] = pydantic.Field(default="ticket_type") + type: typing.Optional[str] = pydantic.Field(default=None) """ String representing the object's type. Always has the value `ticket_type`. """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The id representing the ticket type. """ - category: TicketTypeCategory = pydantic.Field() + category: typing.Optional[TicketTypeCategory] = pydantic.Field(default=None) """ Category of the Ticket Type. """ - name: str = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The name of the ticket type """ - description: str = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The description of the ticket type """ - icon: str = pydantic.Field() + icon: typing.Optional[str] = pydantic.Field(default=None) """ The icon of the ticket type """ - workspace_id: str = pydantic.Field() + workspace_id: typing.Optional[str] = pydantic.Field(default=None) """ The id of the workspace that the ticket type belongs to. """ - ticket_type_attributes: TicketTypeAttributeList - archived: bool = pydantic.Field() + ticket_type_attributes: typing.Optional[TicketTypeAttributeList] = None + ticket_states: typing.Optional[TicketTypeTicketStates] = pydantic.Field(default=None) + """ + A list of ticket states associated with a given ticket type. + """ + + archived: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the ticket type is archived or not. """ - created_at: int = pydantic.Field() + created_at: typing.Optional[int] = pydantic.Field(default=None) """ The date and time the ticket type was created. """ diff --git a/src/intercom/tickets/types/ticket_type_ticket_states.py b/src/intercom/tickets/types/ticket_type_ticket_states.py new file mode 100644 index 0000000..73d3d3c --- /dev/null +++ b/src/intercom/tickets/types/ticket_type_ticket_states.py @@ -0,0 +1,33 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ...core.pydantic_utilities import IS_PYDANTIC_V2 +from ...core.unchecked_base_model import UncheckedBaseModel +from .ticket_state import TicketState + + +class TicketTypeTicketStates(UncheckedBaseModel): + """ + A list of ticket states associated with a given ticket type. + """ + + type: typing.Optional[str] = pydantic.Field(default=None) + """ + String representing the object's type. Always has the value `list`. + """ + + data: typing.Optional[typing.List[typing.Optional[TicketState]]] = pydantic.Field(default=None) + """ + A list of ticket states associated with a given ticket type. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/intercom/tickets/types/update_ticket_request_state.py b/src/intercom/tickets/types/update_ticket_request_state.py deleted file mode 100644 index effb50f..0000000 --- a/src/intercom/tickets/types/update_ticket_request_state.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -UpdateTicketRequestState = typing.Union[typing.Literal["in_progress", "waiting_on_customer", "resolved"], typing.Any] diff --git a/src/intercom/types/__init__.py b/src/intercom/types/__init__.py index 6cdd39b..a31c0a6 100644 --- a/src/intercom/types/__init__.py +++ b/src/intercom/types/__init__.py @@ -2,7 +2,6 @@ # isort: skip_file -from .action_component import ActionComponent, ActionComponent_Sheet, ActionComponent_Submit, ActionComponent_Url from .activity_log import ActivityLog from .activity_log_activity_type import ActivityLogActivityType from .activity_log_list import ActivityLogList @@ -26,48 +25,26 @@ from .article_translated_content import ArticleTranslatedContent from .assign_conversation_request import AssignConversationRequest from .assign_conversation_request_type import AssignConversationRequestType -from .button_component import ButtonComponent -from .button_component_style import ButtonComponentStyle -from .canvas_object import CanvasObject -from .checkbox_component import CheckboxComponent -from .checkbox_component_save_state import CheckboxComponentSaveState -from .checkbox_option import CheckboxOption +from .away_status_reason import AwayStatusReason +from .call_list import CallList from .close_conversation_request import CloseConversationRequest from .collection_list import CollectionList from .company_attached_contacts import CompanyAttachedContacts from .company_attached_segments import CompanyAttachedSegments +from .company_data import CompanyData from .company_list import CompanyList from .company_scroll import CompanyScroll -from .component import ( - Component, - Component_Button, - Component_Checkbox, - Component_DataTable, - Component_Divider, - Component_Dropdown, - Component_Image, - Component_Input, - Component_List, - Component_SingleSelect, - Component_Spacer, - Component_Text, - Component_Textarea, -) -from .configure_request import ConfigureRequest -from .configure_request_component_id import ConfigureRequestComponentId -from .configure_request_zero import ConfigureRequestZero -from .configure_response import ConfigureResponse -from .configure_response_canvas import ConfigureResponseCanvas from .contact_archived import ContactArchived from .contact_attached_companies import ContactAttachedCompanies +from .contact_blocked import ContactBlocked from .contact_companies import ContactCompanies -from .contact_company import ContactCompany from .contact_deleted import ContactDeleted from .contact_list import ContactList from .contact_location import ContactLocation from .contact_notes import ContactNotes from .contact_reference import ContactReference from .contact_reply_base_request import ContactReplyBaseRequest +from .contact_reply_base_request_reply_options_item import ContactReplyBaseRequestReplyOptionsItem from .contact_reply_conversation_request import ContactReplyConversationRequest from .contact_reply_email_request import ContactReplyEmailRequest from .contact_reply_intercom_user_id_request import ContactReplyIntercomUserIdRequest @@ -81,31 +58,50 @@ from .contact_subscription_types import ContactSubscriptionTypes from .contact_tags import ContactTags from .contact_unarchived import ContactUnarchived -from .content_object import ContentObject from .content_sources_list import ContentSourcesList -from .context import Context -from .context_location import ContextLocation from .conversation_attachment_files import ConversationAttachmentFiles +from .conversation_attribute_updated_by_admin import ConversationAttributeUpdatedByAdmin +from .conversation_attribute_updated_by_admin_attribute import ConversationAttributeUpdatedByAdminAttribute +from .conversation_attribute_updated_by_admin_value import ConversationAttributeUpdatedByAdminValue +from .conversation_attribute_updated_by_workflow import ConversationAttributeUpdatedByWorkflow +from .conversation_attribute_updated_by_workflow_attribute import ConversationAttributeUpdatedByWorkflowAttribute +from .conversation_attribute_updated_by_workflow_value import ConversationAttributeUpdatedByWorkflowValue +from .conversation_attribute_updated_by_workflow_workflow import ConversationAttributeUpdatedByWorkflowWorkflow from .conversation_contacts import ConversationContacts +from .conversation_deleted import ConversationDeleted from .conversation_first_contact_reply import ConversationFirstContactReply +from .conversation_list import ConversationList from .conversation_part import ConversationPart from .conversation_part_author import ConversationPartAuthor +from .conversation_part_metadata import ConversationPartMetadata +from .conversation_part_metadata_quick_reply_options_item import ConversationPartMetadataQuickReplyOptionsItem +from .conversation_part_state import ConversationPartState from .conversation_parts import ConversationParts from .conversation_rating import ConversationRating +from .conversation_response_time import ConversationResponseTime from .conversation_source import ConversationSource from .conversation_source_type import ConversationSourceType from .conversation_statistics import ConversationStatistics from .conversation_teammates import ConversationTeammates +from .create_article_request import CreateArticleRequest +from .create_article_request_parent_type import CreateArticleRequestParentType +from .create_article_request_state import CreateArticleRequestState from .create_contact_request import CreateContactRequest from .create_contact_request_two import CreateContactRequestTwo from .create_contact_request_with_email import CreateContactRequestWithEmail from .create_contact_request_with_external_id import CreateContactRequestWithExternalId from .create_contact_request_with_role import CreateContactRequestWithRole +from .create_data_attribute_request import CreateDataAttributeRequest +from .create_data_attribute_request_one import CreateDataAttributeRequestOne +from .create_data_attribute_request_one_data_type import CreateDataAttributeRequestOneDataType +from .create_data_attribute_request_options import CreateDataAttributeRequestOptions +from .create_data_attribute_request_options_options_item import CreateDataAttributeRequestOptionsOptionsItem from .create_data_event_request import CreateDataEventRequest from .create_data_event_request_two import CreateDataEventRequestTwo from .create_data_event_request_with_email import CreateDataEventRequestWithEmail from .create_data_event_request_with_id import CreateDataEventRequestWithId from .create_data_event_request_with_user_id import CreateDataEventRequestWithUserId +from .create_internal_article_request import CreateInternalArticleRequest from .create_message_request import CreateMessageRequest, CreateMessageRequest_Email, CreateMessageRequest_Inapp from .create_message_request_from import CreateMessageRequestFrom from .create_message_request_three import CreateMessageRequestThree @@ -113,16 +109,33 @@ from .create_message_request_type import CreateMessageRequestType from .create_message_request_with_email import CreateMessageRequestWithEmail from .create_message_request_with_inapp import CreateMessageRequestWithInapp +from .create_or_update_company_request import CreateOrUpdateCompanyRequest from .create_or_update_tag_request import CreateOrUpdateTagRequest +from .create_phone_switch_request import CreatePhoneSwitchRequest from .create_ticket_reply_with_comment_request import CreateTicketReplyWithCommentRequest -from .create_ticket_request import CreateTicketRequest +from .create_ticket_request_assignment import CreateTicketRequestAssignment +from .create_ticket_request_body import CreateTicketRequestBody from .create_ticket_request_contacts_item import CreateTicketRequestContactsItem from .create_ticket_request_contacts_item_email import CreateTicketRequestContactsItemEmail from .create_ticket_request_contacts_item_external_id import CreateTicketRequestContactsItemExternalId from .create_ticket_request_contacts_item_id import CreateTicketRequestContactsItemId -from .current_canvas import CurrentCanvas +from .create_ticket_type_request import CreateTicketTypeRequest +from .create_ticket_type_request_category import CreateTicketTypeRequestCategory from .cursor_pages import CursorPages +from .custom_action_finished import CustomActionFinished +from .custom_action_finished_action import CustomActionFinishedAction +from .custom_action_finished_action_result import CustomActionFinishedActionResult +from .custom_action_started import CustomActionStarted +from .custom_action_started_action import CustomActionStartedAction from .custom_attributes import CustomAttributes +from .custom_attributes_value import CustomAttributesValue +from .custom_channel_attribute import CustomChannelAttribute +from .custom_channel_base_event import CustomChannelBaseEvent +from .custom_channel_contact import CustomChannelContact +from .custom_channel_contact_type import CustomChannelContactType +from .custom_channel_notification_response import CustomChannelNotificationResponse +from .custom_object_instance_deleted import CustomObjectInstanceDeleted +from .custom_object_instance_list import CustomObjectInstanceList from .customer_request import CustomerRequest from .customer_request_email import CustomerRequestEmail from .customer_request_intercom_user_id import CustomerRequestIntercomUserId @@ -133,53 +146,51 @@ from .data_event_summary import DataEventSummary from .data_event_summary_item import DataEventSummaryItem from .data_export_csv import DataExportCsv -from .data_table_component import DataTableComponent -from .data_table_item import DataTableItem +from .datetime import Datetime from .deleted_article_object import DeletedArticleObject from .deleted_collection_object import DeletedCollectionObject from .deleted_company_object import DeletedCompanyObject +from .deleted_internal_article_object import DeletedInternalArticleObject from .deleted_object import DeletedObject -from .divider_component import DividerComponent -from .dropdown_component import DropdownComponent -from .dropdown_component_save_state import DropdownComponentSaveState -from .dropdown_option import DropdownOption +from .email_address_header import EmailAddressHeader +from .email_message_metadata import EmailMessageMetadata from .error import Error from .error_errors_item import ErrorErrorsItem -from .event import Event +from .event_details import EventDetails from .file_attribute import FileAttribute from .group_content import GroupContent from .group_translated_content import GroupTranslatedContent -from .image_component import ImageComponent -from .image_component_align import ImageComponentAlign -from .initialize_request import InitializeRequest -from .initialize_response import InitializeResponse -from .input_component import InputComponent -from .input_component_save_state import InputComponentSaveState +from .internal_article_list import InternalArticleList from .linked_object import LinkedObject from .linked_object_list import LinkedObjectList from .linked_object_type import LinkedObjectType -from .list_component import ListComponent -from .list_component_items_item import ListComponentItemsItem -from .list_item import ListItem -from .list_item_with_image import ListItemWithImage -from .list_item_without_image import ListItemWithoutImage -from .live_canvas_request import LiveCanvasRequest -from .live_canvas_response import LiveCanvasResponse from .metadata import Metadata from .multiple_filter_search_request import MultipleFilterSearchRequest from .multiple_filter_search_request_operator import MultipleFilterSearchRequestOperator -from .multiple_or_single_filter_search_request import MultipleOrSingleFilterSearchRequest +from .multiple_filter_search_request_value import MultipleFilterSearchRequestValue from .news_item_request import NewsItemRequest from .news_item_request_state import NewsItemRequestState +from .not_found_error_body import NotFoundErrorBody +from .not_found_error_body_errors_item import NotFoundErrorBodyErrorsItem from .note_list import NoteList from .offset_pages import OffsetPages from .open_conversation_request import OpenConversationRequest +from .operator_workflow_event import OperatorWorkflowEvent +from .operator_workflow_event_event import OperatorWorkflowEventEvent +from .operator_workflow_event_workflow import OperatorWorkflowEventWorkflow from .pages_link import PagesLink -from .paginated_conversation_response import PaginatedConversationResponse -from .paginated_news_item_response import PaginatedNewsItemResponse -from .paginated_newsfeed_response import PaginatedNewsfeedResponse +from .paginated_response import PaginatedResponse +from .paginated_response_data_item import ( + PaginatedResponseDataItem, + PaginatedResponseDataItem_NewsItem, + PaginatedResponseDataItem_Newsfeed, +) +from .paginated_response_type import PaginatedResponseType from .part_attachment import PartAttachment from .phone_switch import PhoneSwitch +from .quick_reply_option import QuickReplyOption +from .recipient import Recipient +from .recipient_type import RecipientType from .redact_conversation_request import ( RedactConversationRequest, RedactConversationRequest_ConversationPart, @@ -189,27 +200,18 @@ from .redact_conversation_request_source import RedactConversationRequestSource from .reference import Reference from .reply_conversation_request import ReplyConversationRequest -from .results_response import ResultsResponse from .search_request import SearchRequest from .search_request_query import SearchRequestQuery from .segment_list import SegmentList -from .sheet_action_component import SheetActionComponent from .single_filter_search_request import SingleFilterSearchRequest from .single_filter_search_request_operator import SingleFilterSearchRequestOperator from .single_filter_search_request_value import SingleFilterSearchRequestValue -from .single_select_component import SingleSelectComponent -from .single_select_component_save_state import SingleSelectComponentSaveState -from .single_select_option import SingleSelectOption +from .single_filter_search_request_value_item import SingleFilterSearchRequestValueItem from .sla_applied import SlaApplied from .sla_applied_sla_status import SlaAppliedSlaStatus from .snooze_conversation_request import SnoozeConversationRequest from .social_profile import SocialProfile -from .spacer_component import SpacerComponent -from .spacer_component_size import SpacerComponentSize from .starting_after_paging import StartingAfterPaging -from .submit_action_component import SubmitActionComponent -from .submit_request import SubmitRequest -from .submit_response import SubmitResponse from .subscription_type_list import SubscriptionTypeList from .tag_company_request import TagCompanyRequest from .tag_company_request_companies_item import TagCompanyRequestCompaniesItem @@ -219,10 +221,6 @@ from .tags import Tags from .team_list import TeamList from .team_priority_level import TeamPriorityLevel -from .text_area_component import TextAreaComponent -from .text_component import TextComponent -from .text_component_align import TextComponentAlign -from .text_component_style import TextComponentStyle from .ticket_custom_attributes import TicketCustomAttributes from .ticket_list import TicketList from .ticket_part_author import TicketPartAuthor @@ -231,6 +229,7 @@ from .ticket_reply import TicketReply from .ticket_reply_part_type import TicketReplyPartType from .ticket_request_custom_attributes import TicketRequestCustomAttributes +from .ticket_state_list import TicketStateList from .ticket_type_attribute import TicketTypeAttribute from .ticket_type_attribute_data_type import TicketTypeAttributeDataType from .ticket_type_attribute_list import TicketTypeAttributeList @@ -238,11 +237,15 @@ from .translation import Translation from .untag_company_request import UntagCompanyRequest from .untag_company_request_companies_item import UntagCompanyRequestCompaniesItem +from .update_article_request_body import UpdateArticleRequestBody +from .update_article_request_body_parent_type import UpdateArticleRequestBodyParentType +from .update_data_attribute_request_body import UpdateDataAttributeRequestBody +from .update_data_attribute_request_options import UpdateDataAttributeRequestOptions +from .update_data_attribute_request_options_options_item import UpdateDataAttributeRequestOptionsOptionsItem from .update_visitor_request import UpdateVisitorRequest from .update_visitor_request_one import UpdateVisitorRequestOne from .update_visitor_request_with_id import UpdateVisitorRequestWithId from .update_visitor_request_with_user_id import UpdateVisitorRequestWithUserId -from .url_action_component import UrlActionComponent from .visitor import Visitor from .visitor_avatar import VisitorAvatar from .visitor_companies import VisitorCompanies @@ -252,12 +255,13 @@ from .visitor_social_profiles import VisitorSocialProfiles from .visitor_tags import VisitorTags from .visitor_tags_tags_item import VisitorTagsTagsItem +from .whatsapp_message_status_list import WhatsappMessageStatusList +from .whatsapp_message_status_list_events_item import WhatsappMessageStatusListEventsItem +from .whatsapp_message_status_list_events_item_status import WhatsappMessageStatusListEventsItemStatus +from .whatsapp_message_status_list_pages import WhatsappMessageStatusListPages +from .whatsapp_message_status_list_pages_next import WhatsappMessageStatusListPagesNext __all__ = [ - "ActionComponent", - "ActionComponent_Sheet", - "ActionComponent_Submit", - "ActionComponent_Url", "ActivityLog", "ActivityLogActivityType", "ActivityLogList", @@ -281,46 +285,26 @@ "ArticleTranslatedContent", "AssignConversationRequest", "AssignConversationRequestType", - "ButtonComponent", - "ButtonComponentStyle", - "CanvasObject", - "CheckboxComponent", - "CheckboxComponentSaveState", - "CheckboxOption", + "AwayStatusReason", + "CallList", "CloseConversationRequest", "CollectionList", "CompanyAttachedContacts", "CompanyAttachedSegments", + "CompanyData", "CompanyList", "CompanyScroll", - "Component", - "Component_Button", - "Component_Checkbox", - "Component_DataTable", - "Component_Divider", - "Component_Dropdown", - "Component_Image", - "Component_Input", - "Component_List", - "Component_SingleSelect", - "Component_Spacer", - "Component_Text", - "Component_Textarea", - "ConfigureRequest", - "ConfigureRequestComponentId", - "ConfigureRequestZero", - "ConfigureResponse", - "ConfigureResponseCanvas", "ContactArchived", "ContactAttachedCompanies", + "ContactBlocked", "ContactCompanies", - "ContactCompany", "ContactDeleted", "ContactList", "ContactLocation", "ContactNotes", "ContactReference", "ContactReplyBaseRequest", + "ContactReplyBaseRequestReplyOptionsItem", "ContactReplyConversationRequest", "ContactReplyEmailRequest", "ContactReplyIntercomUserIdRequest", @@ -334,31 +318,50 @@ "ContactSubscriptionTypes", "ContactTags", "ContactUnarchived", - "ContentObject", "ContentSourcesList", - "Context", - "ContextLocation", "ConversationAttachmentFiles", + "ConversationAttributeUpdatedByAdmin", + "ConversationAttributeUpdatedByAdminAttribute", + "ConversationAttributeUpdatedByAdminValue", + "ConversationAttributeUpdatedByWorkflow", + "ConversationAttributeUpdatedByWorkflowAttribute", + "ConversationAttributeUpdatedByWorkflowValue", + "ConversationAttributeUpdatedByWorkflowWorkflow", "ConversationContacts", + "ConversationDeleted", "ConversationFirstContactReply", + "ConversationList", "ConversationPart", "ConversationPartAuthor", + "ConversationPartMetadata", + "ConversationPartMetadataQuickReplyOptionsItem", + "ConversationPartState", "ConversationParts", "ConversationRating", + "ConversationResponseTime", "ConversationSource", "ConversationSourceType", "ConversationStatistics", "ConversationTeammates", + "CreateArticleRequest", + "CreateArticleRequestParentType", + "CreateArticleRequestState", "CreateContactRequest", "CreateContactRequestTwo", "CreateContactRequestWithEmail", "CreateContactRequestWithExternalId", "CreateContactRequestWithRole", + "CreateDataAttributeRequest", + "CreateDataAttributeRequestOne", + "CreateDataAttributeRequestOneDataType", + "CreateDataAttributeRequestOptions", + "CreateDataAttributeRequestOptionsOptionsItem", "CreateDataEventRequest", "CreateDataEventRequestTwo", "CreateDataEventRequestWithEmail", "CreateDataEventRequestWithId", "CreateDataEventRequestWithUserId", + "CreateInternalArticleRequest", "CreateMessageRequest", "CreateMessageRequestFrom", "CreateMessageRequestThree", @@ -368,16 +371,33 @@ "CreateMessageRequestWithInapp", "CreateMessageRequest_Email", "CreateMessageRequest_Inapp", + "CreateOrUpdateCompanyRequest", "CreateOrUpdateTagRequest", + "CreatePhoneSwitchRequest", "CreateTicketReplyWithCommentRequest", - "CreateTicketRequest", + "CreateTicketRequestAssignment", + "CreateTicketRequestBody", "CreateTicketRequestContactsItem", "CreateTicketRequestContactsItemEmail", "CreateTicketRequestContactsItemExternalId", "CreateTicketRequestContactsItemId", - "CurrentCanvas", + "CreateTicketTypeRequest", + "CreateTicketTypeRequestCategory", "CursorPages", + "CustomActionFinished", + "CustomActionFinishedAction", + "CustomActionFinishedActionResult", + "CustomActionStarted", + "CustomActionStartedAction", "CustomAttributes", + "CustomAttributesValue", + "CustomChannelAttribute", + "CustomChannelBaseEvent", + "CustomChannelContact", + "CustomChannelContactType", + "CustomChannelNotificationResponse", + "CustomObjectInstanceDeleted", + "CustomObjectInstanceList", "CustomerRequest", "CustomerRequestEmail", "CustomerRequestIntercomUserId", @@ -388,53 +408,49 @@ "DataEventSummary", "DataEventSummaryItem", "DataExportCsv", - "DataTableComponent", - "DataTableItem", + "Datetime", "DeletedArticleObject", "DeletedCollectionObject", "DeletedCompanyObject", + "DeletedInternalArticleObject", "DeletedObject", - "DividerComponent", - "DropdownComponent", - "DropdownComponentSaveState", - "DropdownOption", + "EmailAddressHeader", + "EmailMessageMetadata", "Error", "ErrorErrorsItem", - "Event", + "EventDetails", "FileAttribute", "GroupContent", "GroupTranslatedContent", - "ImageComponent", - "ImageComponentAlign", - "InitializeRequest", - "InitializeResponse", - "InputComponent", - "InputComponentSaveState", + "InternalArticleList", "LinkedObject", "LinkedObjectList", "LinkedObjectType", - "ListComponent", - "ListComponentItemsItem", - "ListItem", - "ListItemWithImage", - "ListItemWithoutImage", - "LiveCanvasRequest", - "LiveCanvasResponse", "Metadata", "MultipleFilterSearchRequest", "MultipleFilterSearchRequestOperator", - "MultipleOrSingleFilterSearchRequest", + "MultipleFilterSearchRequestValue", "NewsItemRequest", "NewsItemRequestState", + "NotFoundErrorBody", + "NotFoundErrorBodyErrorsItem", "NoteList", "OffsetPages", "OpenConversationRequest", + "OperatorWorkflowEvent", + "OperatorWorkflowEventEvent", + "OperatorWorkflowEventWorkflow", "PagesLink", - "PaginatedConversationResponse", - "PaginatedNewsItemResponse", - "PaginatedNewsfeedResponse", + "PaginatedResponse", + "PaginatedResponseDataItem", + "PaginatedResponseDataItem_NewsItem", + "PaginatedResponseDataItem_Newsfeed", + "PaginatedResponseType", "PartAttachment", "PhoneSwitch", + "QuickReplyOption", + "Recipient", + "RecipientType", "RedactConversationRequest", "RedactConversationRequestConversationPart", "RedactConversationRequestSource", @@ -442,27 +458,18 @@ "RedactConversationRequest_Source", "Reference", "ReplyConversationRequest", - "ResultsResponse", "SearchRequest", "SearchRequestQuery", "SegmentList", - "SheetActionComponent", "SingleFilterSearchRequest", "SingleFilterSearchRequestOperator", "SingleFilterSearchRequestValue", - "SingleSelectComponent", - "SingleSelectComponentSaveState", - "SingleSelectOption", + "SingleFilterSearchRequestValueItem", "SlaApplied", "SlaAppliedSlaStatus", "SnoozeConversationRequest", "SocialProfile", - "SpacerComponent", - "SpacerComponentSize", "StartingAfterPaging", - "SubmitActionComponent", - "SubmitRequest", - "SubmitResponse", "SubscriptionTypeList", "TagCompanyRequest", "TagCompanyRequestCompaniesItem", @@ -472,10 +479,6 @@ "Tags", "TeamList", "TeamPriorityLevel", - "TextAreaComponent", - "TextComponent", - "TextComponentAlign", - "TextComponentStyle", "TicketCustomAttributes", "TicketList", "TicketPartAuthor", @@ -484,6 +487,7 @@ "TicketReply", "TicketReplyPartType", "TicketRequestCustomAttributes", + "TicketStateList", "TicketTypeAttribute", "TicketTypeAttributeDataType", "TicketTypeAttributeList", @@ -491,11 +495,15 @@ "Translation", "UntagCompanyRequest", "UntagCompanyRequestCompaniesItem", + "UpdateArticleRequestBody", + "UpdateArticleRequestBodyParentType", + "UpdateDataAttributeRequestBody", + "UpdateDataAttributeRequestOptions", + "UpdateDataAttributeRequestOptionsOptionsItem", "UpdateVisitorRequest", "UpdateVisitorRequestOne", "UpdateVisitorRequestWithId", "UpdateVisitorRequestWithUserId", - "UrlActionComponent", "Visitor", "VisitorAvatar", "VisitorCompanies", @@ -505,4 +513,9 @@ "VisitorSocialProfiles", "VisitorTags", "VisitorTagsTagsItem", + "WhatsappMessageStatusList", + "WhatsappMessageStatusListEventsItem", + "WhatsappMessageStatusListEventsItemStatus", + "WhatsappMessageStatusListPages", + "WhatsappMessageStatusListPagesNext", ] diff --git a/src/intercom/types/action_component.py b/src/intercom/types/action_component.py deleted file mode 100644 index ccab028..0000000 --- a/src/intercom/types/action_component.py +++ /dev/null @@ -1,56 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from __future__ import annotations - -import typing - -import pydantic -import typing_extensions -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from ..core.unchecked_base_model import UncheckedBaseModel, UnionMetadata - - -class ActionComponent_Sheet(UncheckedBaseModel): - type: typing.Literal["sheet"] = "sheet" - url: str - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class ActionComponent_Url(UncheckedBaseModel): - type: typing.Literal["url"] = "url" - url: str - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class ActionComponent_Submit(UncheckedBaseModel): - type: typing.Literal["submit"] = "submit" - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -ActionComponent = typing_extensions.Annotated[ - typing.Union[ActionComponent_Sheet, ActionComponent_Url, ActionComponent_Submit], UnionMetadata(discriminant="type") -] diff --git a/src/intercom/types/activity_log.py b/src/intercom/types/activity_log.py index 7aad54b..b775941 100644 --- a/src/intercom/types/activity_log.py +++ b/src/intercom/types/activity_log.py @@ -15,12 +15,12 @@ class ActivityLog(UncheckedBaseModel): Activities performed by Admins. """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The id representing the activity. """ - performed_by: ActivityLogPerformedBy = pydantic.Field() + performed_by: typing.Optional[ActivityLogPerformedBy] = pydantic.Field(default=None) """ Details about the Admin involved in the activity. """ @@ -31,7 +31,7 @@ class ActivityLog(UncheckedBaseModel): The time the activity was created. """ - activity_type: ActivityLogActivityType + activity_type: typing.Optional[ActivityLogActivityType] = None activity_description: typing.Optional[str] = pydantic.Field(default=None) """ A sentence or two describing the activity. diff --git a/src/intercom/types/activity_log_activity_type.py b/src/intercom/types/activity_log_activity_type.py index 48d6405..d0fc757 100644 --- a/src/intercom/types/activity_log_activity_type.py +++ b/src/intercom/types/activity_log_activity_type.py @@ -4,7 +4,8 @@ ActivityLogActivityType = typing.Union[ typing.Literal[ - "admin_assignment_limit_change", + "admin_conversation_assignment_limit_change", + "admin_ticket_assignment_limit_change", "admin_away_mode_change", "admin_deletion", "admin_deprovisioned", diff --git a/src/intercom/types/activity_log_list.py b/src/intercom/types/activity_log_list.py index 105a7c0..3d0bf0a 100644 --- a/src/intercom/types/activity_log_list.py +++ b/src/intercom/types/activity_log_list.py @@ -14,13 +14,13 @@ class ActivityLogList(UncheckedBaseModel): A paginated list of activity logs. """ - type: typing.Literal["activity_log.list"] = pydantic.Field(default="activity_log.list") + type: typing.Optional[str] = pydantic.Field(default=None) """ String representing the object's type. Always has the value `activity_log.list`. """ pages: typing.Optional[CursorPages] = None - activity_logs: typing.List[ActivityLog] = pydantic.Field() + activity_logs: typing.Optional[typing.List[typing.Optional[ActivityLog]]] = pydantic.Field(default=None) """ An array of activity logs """ diff --git a/src/intercom/types/activity_log_metadata.py b/src/intercom/types/activity_log_metadata.py index 8c0d436..09d848f 100644 --- a/src/intercom/types/activity_log_metadata.py +++ b/src/intercom/types/activity_log_metadata.py @@ -57,6 +57,16 @@ class ActivityLogMetadata(UncheckedBaseModel): The name of the Admin who initiated the activity. """ + conversation_assignment_limit: typing.Optional[int] = pydantic.Field(default=None) + """ + The conversation assignment limit value for an admin. + """ + + ticket_assignment_limit: typing.Optional[int] = pydantic.Field(default=None) + """ + The ticket assignment limit value for an admin. + """ + if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 else: diff --git a/src/intercom/types/activity_log_performed_by.py b/src/intercom/types/activity_log_performed_by.py index af8bcf8..21311c5 100644 --- a/src/intercom/types/activity_log_performed_by.py +++ b/src/intercom/types/activity_log_performed_by.py @@ -12,7 +12,7 @@ class ActivityLogPerformedBy(UncheckedBaseModel): Details about the Admin involved in the activity. """ - type: typing.Optional[typing.Literal["admin"]] = pydantic.Field(default=None) + type: typing.Optional[str] = pydantic.Field(default=None) """ String representing the object's type. Always has the value `admin`. """ diff --git a/src/intercom/types/addressable_list.py b/src/intercom/types/addressable_list.py index 4ed668e..7c9b76e 100644 --- a/src/intercom/types/addressable_list.py +++ b/src/intercom/types/addressable_list.py @@ -12,17 +12,17 @@ class AddressableList(UncheckedBaseModel): A list used to access other resources from a parent model. """ - type: str = pydantic.Field() + type: typing.Optional[str] = pydantic.Field(default=None) """ The addressable object type """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The id of the addressable object """ - url: str = pydantic.Field() + url: typing.Optional[str] = pydantic.Field(default=None) """ Url to get more company resources for this contact """ diff --git a/src/intercom/types/admin_list.py b/src/intercom/types/admin_list.py index 7ccd717..39feaca 100644 --- a/src/intercom/types/admin_list.py +++ b/src/intercom/types/admin_list.py @@ -13,12 +13,12 @@ class AdminList(UncheckedBaseModel): A list of admins associated with a given workspace. """ - type: typing.Literal["admin.list"] = pydantic.Field(default="admin.list") + type: typing.Optional[str] = pydantic.Field(default=None) """ String representing the object's type. Always has the value `admin.list`. """ - admins: typing.List[Admin] = pydantic.Field() + admins: typing.Optional[typing.List[typing.Optional[Admin]]] = pydantic.Field(default=None) """ A list of admins associated with a given workspace. """ diff --git a/src/intercom/types/admin_reply_conversation_request.py b/src/intercom/types/admin_reply_conversation_request.py index 35451ff..253ccb3 100644 --- a/src/intercom/types/admin_reply_conversation_request.py +++ b/src/intercom/types/admin_reply_conversation_request.py @@ -7,6 +7,7 @@ from ..core.unchecked_base_model import UncheckedBaseModel from .admin_reply_conversation_request_message_type import AdminReplyConversationRequestMessageType from .conversation_attachment_files import ConversationAttachmentFiles +from .quick_reply_option import QuickReplyOption class AdminReplyConversationRequest(UncheckedBaseModel): @@ -31,6 +32,11 @@ class AdminReplyConversationRequest(UncheckedBaseModel): The time the reply was created. If not provided, the current time will be used. """ + reply_options: typing.Optional[typing.List[QuickReplyOption]] = pydantic.Field(default=None) + """ + The quick reply options to display to the end user. Must be present for quick_reply message types. + """ + attachment_urls: typing.Optional[typing.List[str]] = pydantic.Field(default=None) """ A list of image URLs that will be added as attachments. You can include up to 10 URLs. diff --git a/src/intercom/types/admin_reply_conversation_request_message_type.py b/src/intercom/types/admin_reply_conversation_request_message_type.py index de8dd8c..23e821b 100644 --- a/src/intercom/types/admin_reply_conversation_request_message_type.py +++ b/src/intercom/types/admin_reply_conversation_request_message_type.py @@ -2,4 +2,4 @@ import typing -AdminReplyConversationRequestMessageType = typing.Union[typing.Literal["comment", "note"], typing.Any] +AdminReplyConversationRequestMessageType = typing.Union[typing.Literal["comment", "note", "quick_reply"], typing.Any] diff --git a/src/intercom/types/admin_with_app.py b/src/intercom/types/admin_with_app.py index a82a150..9d8cfa5 100644 --- a/src/intercom/types/admin_with_app.py +++ b/src/intercom/types/admin_with_app.py @@ -14,47 +14,47 @@ class AdminWithApp(UncheckedBaseModel): Admins are the teammate accounts that have access to a workspace """ - type: typing.Literal["admin"] = pydantic.Field(default="admin") + type: typing.Optional[str] = pydantic.Field(default=None) """ String representing the object's type. Always has the value `admin`. """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The id representing the admin. """ - name: str = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The name of the admin. """ - email: str = pydantic.Field() + email: typing.Optional[str] = pydantic.Field(default=None) """ The email of the admin. """ - job_title: str = pydantic.Field() + job_title: typing.Optional[str] = pydantic.Field(default=None) """ The job title of the admin. """ - away_mode_enabled: bool = pydantic.Field() + away_mode_enabled: typing.Optional[bool] = pydantic.Field(default=None) """ Identifies if this admin is currently set in away mode. """ - away_mode_reassign: bool = pydantic.Field() + away_mode_reassign: typing.Optional[bool] = pydantic.Field(default=None) """ Identifies if this admin is set to automatically reassign new conversations to the apps default inbox. """ - has_inbox_seat: bool = pydantic.Field() + has_inbox_seat: typing.Optional[bool] = pydantic.Field(default=None) """ Identifies if this admin has a paid inbox seat to restrict/allow features that require them. """ - team_ids: typing.List[int] = pydantic.Field() + team_ids: typing.Optional[typing.List[int]] = pydantic.Field(default=None) """ This is a list of ids of the teams that this admin is part of. """ diff --git a/src/intercom/types/admin_with_app_avatar.py b/src/intercom/types/admin_with_app_avatar.py index 48aac24..3495059 100644 --- a/src/intercom/types/admin_with_app_avatar.py +++ b/src/intercom/types/admin_with_app_avatar.py @@ -12,7 +12,7 @@ class AdminWithAppAvatar(UncheckedBaseModel): This object represents the avatar associated with the admin. """ - type: typing.Optional[typing.Literal["avatar"]] = pydantic.Field(default=None) + type: typing.Optional[str] = pydantic.Field(default=None) """ This is a string that identifies the type of the object. It will always have the value `avatar`. """ diff --git a/src/intercom/types/app.py b/src/intercom/types/app.py index 36711e9..fed90a5 100644 --- a/src/intercom/types/app.py +++ b/src/intercom/types/app.py @@ -12,37 +12,37 @@ class App(UncheckedBaseModel): App is a workspace on Intercom """ - type: str = pydantic.Field() + type: typing.Optional[str] = pydantic.Field(default=None) """ """ - id_code: str = pydantic.Field() + id_code: typing.Optional[str] = pydantic.Field(default=None) """ The id of the app. """ - name: str = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The name of the app. """ - region: str = pydantic.Field() + region: typing.Optional[str] = pydantic.Field(default=None) """ The Intercom region the app is located in. """ - timezone: str = pydantic.Field() + timezone: typing.Optional[str] = pydantic.Field(default=None) """ The timezone of the region where the app is located. """ - created_at: int = pydantic.Field() + created_at: typing.Optional[int] = pydantic.Field(default=None) """ When the app was created. """ - identity_verification: bool = pydantic.Field() + identity_verification: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the app uses identity verification. """ diff --git a/src/intercom/types/article_content.py b/src/intercom/types/article_content.py index 071f3ef..f9b7bbc 100644 --- a/src/intercom/types/article_content.py +++ b/src/intercom/types/article_content.py @@ -13,32 +13,32 @@ class ArticleContent(UncheckedBaseModel): The Content of an Article. """ - type: typing.Literal["article_content"] = pydantic.Field(default="article_content") + type: typing.Optional[str] = pydantic.Field(default=None) """ The type of object - `article_content` . """ - title: str = pydantic.Field() + title: typing.Optional[str] = pydantic.Field(default=None) """ The title of the article. """ - description: str = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The description of the article. """ - body: str = pydantic.Field() + body: typing.Optional[str] = pydantic.Field(default=None) """ The body of the article. """ - author_id: int = pydantic.Field() + author_id: typing.Optional[int] = pydantic.Field(default=None) """ The ID of the author of the article. """ - state: ArticleContentState = pydantic.Field() + state: typing.Optional[ArticleContentState] = pydantic.Field(default=None) """ Whether the article is `published` or is a `draft` . """ diff --git a/src/intercom/types/article_list.py b/src/intercom/types/article_list.py index 00943b9..67efb42 100644 --- a/src/intercom/types/article_list.py +++ b/src/intercom/types/article_list.py @@ -13,18 +13,18 @@ class ArticleList(UncheckedBaseModel): This will return a list of articles for the App. """ - type: typing.Literal["list"] = pydantic.Field(default="list") + type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None) """ The type of the object - `list`. """ pages: typing.Optional[typing.Optional[typing.Any]] = None - total_count: int = pydantic.Field() + total_count: typing.Optional[int] = pydantic.Field(default=None) """ A count of the total number of articles. """ - data: typing.List[ArticleListItem] = pydantic.Field() + data: typing.Optional[typing.List[ArticleListItem]] = pydantic.Field(default=None) """ An array of Article objects """ diff --git a/src/intercom/types/article_translated_content.py b/src/intercom/types/article_translated_content.py index acf5968..76493d4 100644 --- a/src/intercom/types/article_translated_content.py +++ b/src/intercom/types/article_translated_content.py @@ -15,7 +15,7 @@ class ArticleTranslatedContent(UncheckedBaseModel): The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article. """ - type: typing.Optional[typing.Literal["article_translated_content"]] = pydantic.Field(default=None) + type: typing.Optional[str] = pydantic.Field(default=None) """ The type of object - article_translated_content. """ diff --git a/src/intercom/types/away_status_reason.py b/src/intercom/types/away_status_reason.py new file mode 100644 index 0000000..e17b875 --- /dev/null +++ b/src/intercom/types/away_status_reason.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.unchecked_base_model import UncheckedBaseModel + + +class AwayStatusReason(UncheckedBaseModel): + type: typing.Optional[str] = None + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier for the away status reason + """ + + label: typing.Optional[str] = pydantic.Field(default=None) + """ + The display text for the away status reason + """ + + emoji: typing.Optional[str] = pydantic.Field(default=None) + """ + The emoji associated with the status reason + """ + + order: typing.Optional[int] = pydantic.Field(default=None) + """ + The display order of the status reason + """ + + deleted: typing.Optional[bool] = pydantic.Field(default=None) + """ + Whether the status reason has been soft deleted + """ + + created_at: typing.Optional[int] = pydantic.Field(default=None) + """ + The Unix timestamp when the status reason was created + """ + + updated_at: typing.Optional[int] = pydantic.Field(default=None) + """ + The Unix timestamp when the status reason was last updated + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/intercom/types/button_component.py b/src/intercom/types/button_component.py deleted file mode 100644 index e5ca43e..0000000 --- a/src/intercom/types/button_component.py +++ /dev/null @@ -1,52 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from ..core.unchecked_base_model import UncheckedBaseModel -from .action_component import ActionComponent -from .button_component_style import ButtonComponentStyle - - -class ButtonComponent(UncheckedBaseModel): - """ - A button component is used to take an action by clicking a button. This can either: - - [Trigger a submit request to be sent](https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/submit-action) Inbox Messenger - - [Open a link in a new page](https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/url-action) Inbox Messenger - - [Open a sheet](https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/sheets-action) Messenger - """ - - id: str = pydantic.Field() - """ - A unique identifier for the component. - """ - - label: str = pydantic.Field() - """ - The text that will be rendered inside the button. - """ - - action: ActionComponent = pydantic.Field() - """ - This can be a Submit Action, URL Action, or Sheets Action. - """ - - style: typing.Optional[ButtonComponentStyle] = pydantic.Field(default=None) - """ - Styles the button. Default is 'primary'. - """ - - disabled: typing.Optional[bool] = pydantic.Field(default=None) - """ - Styles the button and prevents the action. Default is false. - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/intercom/types/button_component_style.py b/src/intercom/types/button_component_style.py deleted file mode 100644 index ea9ad49..0000000 --- a/src/intercom/types/button_component_style.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -ButtonComponentStyle = typing.Union[typing.Literal["primary", "secondary", "link"], typing.Any] diff --git a/src/intercom/types/paginated_news_item_response.py b/src/intercom/types/call_list.py similarity index 59% rename from src/intercom/types/paginated_news_item_response.py rename to src/intercom/types/call_list.py index 1cf9dcd..e1cf109 100644 --- a/src/intercom/types/paginated_news_item_response.py +++ b/src/intercom/types/call_list.py @@ -3,33 +3,34 @@ import typing import pydantic +from ..calls.types.call import Call from ..core.pydantic_utilities import IS_PYDANTIC_V2 from ..core.unchecked_base_model import UncheckedBaseModel -from ..news.types.news_item import NewsItem from .cursor_pages import CursorPages -class PaginatedNewsItemResponse(UncheckedBaseModel): +class CallList(UncheckedBaseModel): """ - Paginated News Item Response + A paginated list of calls. """ - type: typing.Literal["list"] = pydantic.Field(default="list") + type: typing.Optional[str] = pydantic.Field(default=None) """ - The type of object + String representing the object's type. Always has the value `list`. """ - pages: typing.Optional[CursorPages] = None - total_count: int = pydantic.Field() + data: typing.Optional[typing.List[Call]] = pydantic.Field(default=None) """ - A count of the total number of News Items. + A list of calls. """ - data: typing.List[NewsItem] = pydantic.Field() + total_count: typing.Optional[int] = pydantic.Field(default=None) """ - An array of News Items + Total number of items available. """ + pages: typing.Optional[CursorPages] = None + if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 else: diff --git a/src/intercom/types/canvas_object.py b/src/intercom/types/canvas_object.py deleted file mode 100644 index b3f3b74..0000000 --- a/src/intercom/types/canvas_object.py +++ /dev/null @@ -1,43 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from ..core.unchecked_base_model import UncheckedBaseModel -from .content_object import ContentObject - - -class CanvasObject(UncheckedBaseModel): - """ - You have to respond to the majority of requests with a canvas object. This will tell us what UI to show for your app. - - A canvas can either be static (meaning we send you the next request only when an action takes place) or live (meaning we send you the next request when someone views the app). - - - A static canvas needs a ContentObject which will contain the components to show. - - A live canvas needs a `content_url` which we we will make the Live Canvas requests to when the app is viewed. This is only possible for apps viewed or used in the Messenger. - """ - - content: ContentObject = pydantic.Field() - """ - The content object that will be shown as the UI of the app. Max Size is 64KB. - """ - - content_url: typing.Optional[str] = pydantic.Field(default=None) - """ - The URL which we make Live Canvas requests to. You must respond to these with a content object. Max size is 64KB. - """ - - stored_data: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None) - """ - Optional Stored Data that you want to be returned in the next sent request. Max Size is 64KB. - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/intercom/types/checkbox_component.py b/src/intercom/types/checkbox_component.py deleted file mode 100644 index 1c98f18..0000000 --- a/src/intercom/types/checkbox_component.py +++ /dev/null @@ -1,58 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from ..core.unchecked_base_model import UncheckedBaseModel -from .checkbox_component_save_state import CheckboxComponentSaveState -from .checkbox_option import CheckboxOption - - -class CheckboxComponent(UncheckedBaseModel): - """ - A checkbox component is used to capture multiple choices from as many options as you want to provide. You can submit the options by: - - - Using a ButtonComponent (which will submit all interactive components in the canvas) - - When a submit action takes place, the results are given in a hash with the `id` from the checkbox component used as the key and an array containing the `id` of each chosen option as the value. - """ - - id: str = pydantic.Field() - """ - A unique identifier for the component. - """ - - option: typing.List[CheckboxOption] = pydantic.Field() - """ - The list of options. Minimum of 1. - """ - - label: str = pydantic.Field() - """ - The text shown above the options. - """ - - value: typing.Optional[typing.List[str]] = pydantic.Field(default=None) - """ - The option's that are selected by default. - """ - - save_state: typing.Optional[CheckboxComponentSaveState] = pydantic.Field(default=None) - """ - Styles the input. Default is `unsaved`. Prevent action with `saved`. - """ - - disabled: typing.Optional[bool] = pydantic.Field(default=None) - """ - Styles all options and prevents the action. Default is false. Will be overridden if save_state is saved. - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/intercom/types/checkbox_component_save_state.py b/src/intercom/types/checkbox_component_save_state.py deleted file mode 100644 index 33ed701..0000000 --- a/src/intercom/types/checkbox_component_save_state.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -CheckboxComponentSaveState = typing.Union[typing.Literal["unsaved", "saved", "failed"], typing.Any] diff --git a/src/intercom/types/collection_list.py b/src/intercom/types/collection_list.py index 7dafac2..2711d18 100644 --- a/src/intercom/types/collection_list.py +++ b/src/intercom/types/collection_list.py @@ -14,18 +14,18 @@ class CollectionList(UncheckedBaseModel): This will return a list of Collections for the App. """ - type: typing.Literal["list"] = pydantic.Field(default="list") + type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None) """ The type of the object - `list`. """ pages: typing.Optional[OffsetPages] = None - total_count: int = pydantic.Field() + total_count: typing.Optional[int] = pydantic.Field(default=None) """ A count of the total number of collections. """ - data: typing.List[Collection] = pydantic.Field() + data: typing.Optional[typing.List[Collection]] = pydantic.Field(default=None) """ An array of collection objects """ diff --git a/src/intercom/types/company_attached_contacts.py b/src/intercom/types/company_attached_contacts.py index 8240704..6b23ee2 100644 --- a/src/intercom/types/company_attached_contacts.py +++ b/src/intercom/types/company_attached_contacts.py @@ -14,17 +14,17 @@ class CompanyAttachedContacts(UncheckedBaseModel): A list of Contact Objects """ - type: typing.Literal["list"] = pydantic.Field(default="list") + type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None) """ The type of object - `list` """ - data: typing.List[Contact] = pydantic.Field() + data: typing.Optional[typing.List[Contact]] = pydantic.Field(default=None) """ An array containing Contact Objects """ - total_count: int = pydantic.Field() + total_count: typing.Optional[int] = pydantic.Field(default=None) """ The total number of contacts """ diff --git a/src/intercom/types/company_attached_segments.py b/src/intercom/types/company_attached_segments.py index c0a3439..032bebe 100644 --- a/src/intercom/types/company_attached_segments.py +++ b/src/intercom/types/company_attached_segments.py @@ -13,12 +13,12 @@ class CompanyAttachedSegments(UncheckedBaseModel): A list of Segment Objects """ - type: typing.Literal["list"] = pydantic.Field(default="list") + type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None) """ The type of object - `list` """ - data: typing.List[Segment] = pydantic.Field() + data: typing.Optional[typing.List[Segment]] = pydantic.Field(default=None) """ An array containing Segment Objects """ diff --git a/src/intercom/types/spacer_component.py b/src/intercom/types/company_data.py similarity index 58% rename from src/intercom/types/spacer_component.py rename to src/intercom/types/company_data.py index 0374242..34ead61 100644 --- a/src/intercom/types/spacer_component.py +++ b/src/intercom/types/company_data.py @@ -5,22 +5,26 @@ import pydantic from ..core.pydantic_utilities import IS_PYDANTIC_V2 from ..core.unchecked_base_model import UncheckedBaseModel -from .spacer_component_size import SpacerComponentSize -class SpacerComponent(UncheckedBaseModel): +class CompanyData(UncheckedBaseModel): """ - A spacer component is used to create empty space between components. + An object containing data about the companies that a contact is associated with. """ id: typing.Optional[str] = pydantic.Field(default=None) """ - A unique identifier for the component. + The unique identifier for the company which is given by Intercom. """ - size: typing.Optional[SpacerComponentSize] = pydantic.Field(default=None) + type: typing.Optional[typing.Literal["company"]] = pydantic.Field(default=None) """ - The amount of space between components. Default is `s`. + The type of the object. Always company. + """ + + url: typing.Optional[str] = pydantic.Field(default=None) + """ + The relative URL of the company. """ if IS_PYDANTIC_V2: diff --git a/src/intercom/types/company_list.py b/src/intercom/types/company_list.py index 7a67bad..078fa69 100644 --- a/src/intercom/types/company_list.py +++ b/src/intercom/types/company_list.py @@ -15,12 +15,12 @@ class CompanyList(UncheckedBaseModel): """ pages: typing.Optional[OffsetPages] = None - total_count: int = pydantic.Field() + total_count: typing.Optional[int] = pydantic.Field(default=None) """ The total number of companies. """ - data: typing.List[Company] = pydantic.Field() + data: typing.Optional[typing.List[Company]] = pydantic.Field(default=None) """ An array containing Company Objects. """ diff --git a/src/intercom/types/company_scroll.py b/src/intercom/types/company_scroll.py index 72fd10e..a164b4d 100644 --- a/src/intercom/types/company_scroll.py +++ b/src/intercom/types/company_scroll.py @@ -14,12 +14,12 @@ class CompanyScroll(UncheckedBaseModel): Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies. """ - type: typing.Literal["list"] = pydantic.Field(default="list") + type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None) """ The type of object - `list` """ - data: typing.List[Company] + data: typing.Optional[typing.List[Company]] = None pages: typing.Optional[CursorPages] = None total_count: typing.Optional[int] = pydantic.Field(default=None) """ diff --git a/src/intercom/types/component.py b/src/intercom/types/component.py deleted file mode 100644 index 4c9f1ad..0000000 --- a/src/intercom/types/component.py +++ /dev/null @@ -1,258 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from __future__ import annotations - -import typing - -import pydantic -import typing_extensions -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from ..core.unchecked_base_model import UncheckedBaseModel, UnionMetadata -from .action_component import ActionComponent -from .button_component_style import ButtonComponentStyle -from .checkbox_component_save_state import CheckboxComponentSaveState -from .checkbox_option import CheckboxOption -from .data_table_item import DataTableItem -from .dropdown_component_save_state import DropdownComponentSaveState -from .dropdown_option import DropdownOption -from .image_component_align import ImageComponentAlign -from .input_component_save_state import InputComponentSaveState -from .list_component_items_item import ListComponentItemsItem -from .single_select_component_save_state import SingleSelectComponentSaveState -from .single_select_option import SingleSelectOption -from .spacer_component_size import SpacerComponentSize -from .text_component_align import TextComponentAlign -from .text_component_style import TextComponentStyle -from .url_action_component import UrlActionComponent - - -class Component_Button(UncheckedBaseModel): - type: typing.Literal["button"] = "button" - id: str - label: str - action: ActionComponent - style: typing.Optional[ButtonComponentStyle] = None - disabled: typing.Optional[bool] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class Component_Checkbox(UncheckedBaseModel): - type: typing.Literal["checkbox"] = "checkbox" - id: str - option: typing.List[CheckboxOption] - label: str - value: typing.Optional[typing.List[str]] = None - save_state: typing.Optional[CheckboxComponentSaveState] = None - disabled: typing.Optional[bool] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class Component_Dropdown(UncheckedBaseModel): - type: typing.Literal["dropdown"] = "dropdown" - id: str - options: typing.List[DropdownOption] - label: typing.Optional[str] = None - value: typing.Optional[str] = None - save_state: typing.Optional[DropdownComponentSaveState] = None - disabled: typing.Optional[bool] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class Component_Input(UncheckedBaseModel): - type: typing.Literal["input"] = "input" - id: str - label: typing.Optional[str] = None - placeholder: typing.Optional[str] = None - value: typing.Optional[str] = None - action: typing.Optional[ActionComponent] = None - save_state: typing.Optional[InputComponentSaveState] = None - disabled: typing.Optional[bool] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class Component_List(UncheckedBaseModel): - type: typing.Literal["list"] = "list" - items: typing.List[ListComponentItemsItem] - disabled: typing.Optional[bool] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class Component_SingleSelect(UncheckedBaseModel): - type: typing.Literal["single-select"] = "single-select" - id: str - options: typing.List[SingleSelectOption] - label: typing.Optional[str] = None - value: typing.Optional[str] = None - save_state: typing.Optional[SingleSelectComponentSaveState] = None - disabled: typing.Optional[bool] = None - action: typing.Optional[ActionComponent] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class Component_Textarea(UncheckedBaseModel): - type: typing.Literal["textarea"] = "textarea" - id: str - label: typing.Optional[str] = None - placeholder: typing.Optional[str] = None - value: typing.Optional[str] = None - error: typing.Optional[bool] = None - disabled: typing.Optional[bool] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class Component_DataTable(UncheckedBaseModel): - type: typing.Literal["data-table"] = "data-table" - items: typing.List[DataTableItem] - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class Component_Divider(UncheckedBaseModel): - type: typing.Literal["divider"] = "divider" - id: typing.Optional[str] = None - bottom_margin: typing.Optional[typing.Literal["none"]] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class Component_Image(UncheckedBaseModel): - type: typing.Literal["image"] = "image" - id: typing.Optional[str] = None - url: str - align: typing.Optional[ImageComponentAlign] = None - width: int - height: int - rounded: typing.Optional[bool] = None - bottom_margin: typing.Optional[typing.Literal["none"]] = None - action: typing.Optional[UrlActionComponent] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class Component_Spacer(UncheckedBaseModel): - type: typing.Literal["spacer"] = "spacer" - id: typing.Optional[str] = None - size: typing.Optional[SpacerComponentSize] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -class Component_Text(UncheckedBaseModel): - type: typing.Literal["text"] = "text" - id: typing.Optional[str] = None - text: str - align: typing.Optional[TextComponentAlign] = None - style: typing.Optional[TextComponentStyle] = None - bottom_margin: typing.Optional[typing.Literal["none"]] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow - - -Component = typing_extensions.Annotated[ - typing.Union[ - Component_Button, - Component_Checkbox, - Component_Dropdown, - Component_Input, - Component_List, - Component_SingleSelect, - Component_Textarea, - Component_DataTable, - Component_Divider, - Component_Image, - Component_Spacer, - Component_Text, - ], - UnionMetadata(discriminant="type"), -] diff --git a/src/intercom/types/configure_request.py b/src/intercom/types/configure_request.py deleted file mode 100644 index ff26b90..0000000 --- a/src/intercom/types/configure_request.py +++ /dev/null @@ -1,8 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -from .configure_request_component_id import ConfigureRequestComponentId -from .configure_request_zero import ConfigureRequestZero - -ConfigureRequest = typing.Union[ConfigureRequestZero, ConfigureRequestComponentId] diff --git a/src/intercom/types/configure_request_component_id.py b/src/intercom/types/configure_request_component_id.py deleted file mode 100644 index ccd2a11..0000000 --- a/src/intercom/types/configure_request_component_id.py +++ /dev/null @@ -1,56 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -import pydantic -from ..admins.types.admin import Admin -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from ..core.unchecked_base_model import UncheckedBaseModel -from .canvas_object import CanvasObject -from .context import Context - - -class ConfigureRequestComponentId(UncheckedBaseModel): - workspace_id: str = pydantic.Field() - """ - The workspace ID of the teammate. Attribute is app_id for V1.2 and below. - """ - - workspace_region: str = pydantic.Field() - """ - The Intercom hosted region that this app is located in. - """ - - component_id: str = pydantic.Field() - """ - The id of the component clicked by the teammate to trigger the request. - """ - - admin: Admin = pydantic.Field() - """ - The Intercom teammate configuring the app. - """ - - context: Context = pydantic.Field() - """ - The context of where the app is added, where the user last visited, and information on the Messenger settings. - """ - - current_canvas: CanvasObject = pydantic.Field() - """ - The current canvas the teammate can see. - """ - - input_values: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field() - """ - A list of key/value pairs of data, inputted by the teammate on the current canvas. - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/intercom/types/configure_response.py b/src/intercom/types/configure_response.py deleted file mode 100644 index 1f812a1..0000000 --- a/src/intercom/types/configure_response.py +++ /dev/null @@ -1,8 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -from .configure_response_canvas import ConfigureResponseCanvas -from .results_response import ResultsResponse - -ConfigureResponse = typing.Union[ResultsResponse, ConfigureResponseCanvas] diff --git a/src/intercom/types/contact_archived.py b/src/intercom/types/contact_archived.py index 8430ed0..edbc3cc 100644 --- a/src/intercom/types/contact_archived.py +++ b/src/intercom/types/contact_archived.py @@ -4,30 +4,15 @@ import pydantic from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from ..core.unchecked_base_model import UncheckedBaseModel +from .contact_reference import ContactReference -class ContactArchived(UncheckedBaseModel): +class ContactArchived(ContactReference): """ archived contact object """ - type: typing.Literal["contact"] = pydantic.Field(default="contact") - """ - always contact - """ - - id: str = pydantic.Field() - """ - The unique identifier for the contact which is given by Intercom. - """ - - external_id: typing.Optional[str] = pydantic.Field(default=None) - """ - The unique identifier for the contact which is provided by the Client. - """ - - archived: bool = pydantic.Field() + archived: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the contact is archived or not. """ diff --git a/src/intercom/types/contact_attached_companies.py b/src/intercom/types/contact_attached_companies.py index 94c093f..01b7030 100644 --- a/src/intercom/types/contact_attached_companies.py +++ b/src/intercom/types/contact_attached_companies.py @@ -14,17 +14,17 @@ class ContactAttachedCompanies(UncheckedBaseModel): A list of Company Objects """ - type: typing.Literal["list"] = pydantic.Field(default="list") + type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None) """ The type of object """ - companies: typing.List[Company] = pydantic.Field() + companies: typing.Optional[typing.List[Company]] = pydantic.Field(default=None) """ An array containing Company Objects """ - total_count: int = pydantic.Field() + total_count: typing.Optional[int] = pydantic.Field(default=None) """ The total number of companies associated to this contact """ diff --git a/src/intercom/types/list_item_with_image.py b/src/intercom/types/contact_blocked.py similarity index 57% rename from src/intercom/types/list_item_with_image.py rename to src/intercom/types/contact_blocked.py index e69d8a9..caeb5ac 100644 --- a/src/intercom/types/list_item_with_image.py +++ b/src/intercom/types/contact_blocked.py @@ -4,23 +4,17 @@ import pydantic from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from .list_item import ListItem +from .contact_reference import ContactReference -class ListItemWithImage(ListItem): - image: str = pydantic.Field() +class ContactBlocked(ContactReference): """ - An image that will be displayed to the left of the item. + blocked contact object """ - image_width: int = pydantic.Field() + blocked: typing.Optional[bool] = pydantic.Field(default=None) """ - The exact width of the image in pixels. - """ - - image_height: int = pydantic.Field() - """ - The exact height of the image in pixels. + Always true. """ if IS_PYDANTIC_V2: diff --git a/src/intercom/types/contact_companies.py b/src/intercom/types/contact_companies.py index 79ddfcb..8975f79 100644 --- a/src/intercom/types/contact_companies.py +++ b/src/intercom/types/contact_companies.py @@ -5,35 +5,30 @@ import pydantic from ..core.pydantic_utilities import IS_PYDANTIC_V2 from ..core.unchecked_base_model import UncheckedBaseModel -from .contact_company import ContactCompany +from .company_data import CompanyData class ContactCompanies(UncheckedBaseModel): """ - An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more. + An object with metadata about companies attached to a contact . Up to 10 will be displayed here. Use the url to get more. """ - type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None) + data: typing.Optional[typing.List[CompanyData]] = pydantic.Field(default=None) """ - The type of object + An array of company data objects attached to the contact. """ - data: typing.Optional[typing.List[ContactCompany]] = pydantic.Field(default=None) - """ - An array containing Company Objects - """ - - url: str = pydantic.Field() + url: typing.Optional[str] = pydantic.Field(default=None) """ Url to get more company resources for this contact """ - total_count: int = pydantic.Field() + total_count: typing.Optional[int] = pydantic.Field(default=None) """ - Int representing the total number of companyies attached to this contact + Integer representing the total number of companies attached to this contact """ - has_more: bool = pydantic.Field() + has_more: typing.Optional[bool] = pydantic.Field(default=None) """ Whether there's more Addressable Objects to be viewed. If true, use the url to view all """ diff --git a/src/intercom/types/contact_deleted.py b/src/intercom/types/contact_deleted.py index f6e6c80..3b4ba10 100644 --- a/src/intercom/types/contact_deleted.py +++ b/src/intercom/types/contact_deleted.py @@ -4,30 +4,15 @@ import pydantic from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from ..core.unchecked_base_model import UncheckedBaseModel +from .contact_reference import ContactReference -class ContactDeleted(UncheckedBaseModel): +class ContactDeleted(ContactReference): """ deleted contact object """ - type: typing.Literal["contact"] = pydantic.Field(default="contact") - """ - always contact - """ - - id: str = pydantic.Field() - """ - The unique identifier for the contact which is given by Intercom. - """ - - external_id: typing.Optional[str] = pydantic.Field(default=None) - """ - The unique identifier for the contact which is provided by the Client. - """ - - deleted: bool = pydantic.Field() + deleted: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the contact is deleted or not. """ diff --git a/src/intercom/types/contact_list.py b/src/intercom/types/contact_list.py index 867f09f..9d1914d 100644 --- a/src/intercom/types/contact_list.py +++ b/src/intercom/types/contact_list.py @@ -14,17 +14,17 @@ class ContactList(UncheckedBaseModel): Contacts are your users in Intercom. """ - type: typing.Literal["list"] = pydantic.Field(default="list") + type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None) """ Always list """ - data: typing.List[Contact] = pydantic.Field() + data: typing.Optional[typing.List[Contact]] = pydantic.Field(default=None) """ The list of contact objects """ - total_count: int = pydantic.Field() + total_count: typing.Optional[int] = pydantic.Field(default=None) """ A count of the total number of objects. """ diff --git a/src/intercom/types/contact_location.py b/src/intercom/types/contact_location.py index 0866784..f24ea02 100644 --- a/src/intercom/types/contact_location.py +++ b/src/intercom/types/contact_location.py @@ -12,7 +12,7 @@ class ContactLocation(UncheckedBaseModel): An object containing location meta data about a Intercom contact. """ - type: typing.Literal["location"] = pydantic.Field(default="location") + type: typing.Optional[str] = pydantic.Field(default=None) """ Always location """ diff --git a/src/intercom/types/contact_notes.py b/src/intercom/types/contact_notes.py index 9cf498f..e81bc8c 100644 --- a/src/intercom/types/contact_notes.py +++ b/src/intercom/types/contact_notes.py @@ -13,22 +13,22 @@ class ContactNotes(UncheckedBaseModel): An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more. """ - data: typing.List[AddressableList] = pydantic.Field() + data: typing.Optional[typing.List[AddressableList]] = pydantic.Field(default=None) """ This object represents the notes attached to a contact. """ - url: str = pydantic.Field() + url: typing.Optional[str] = pydantic.Field(default=None) """ Url to get more company resources for this contact """ - total_count: int = pydantic.Field() + total_count: typing.Optional[int] = pydantic.Field(default=None) """ Int representing the total number of companyies attached to this contact """ - has_more: bool = pydantic.Field() + has_more: typing.Optional[bool] = pydantic.Field(default=None) """ Whether there's more Addressable Objects to be viewed. If true, use the url to view all """ diff --git a/src/intercom/types/contact_reference.py b/src/intercom/types/contact_reference.py index e5502fe..5e07f67 100644 --- a/src/intercom/types/contact_reference.py +++ b/src/intercom/types/contact_reference.py @@ -12,12 +12,12 @@ class ContactReference(UncheckedBaseModel): reference to contact object """ - type: typing.Literal["contact"] = pydantic.Field(default="contact") + type: typing.Optional[typing.Literal["contact"]] = pydantic.Field(default=None) """ always contact """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ The unique identifier for the contact which is given by Intercom. """ diff --git a/src/intercom/types/contact_reply_base_request.py b/src/intercom/types/contact_reply_base_request.py index 49d6df9..41d6be3 100644 --- a/src/intercom/types/contact_reply_base_request.py +++ b/src/intercom/types/contact_reply_base_request.py @@ -5,6 +5,7 @@ import pydantic from ..core.pydantic_utilities import IS_PYDANTIC_V2 from ..core.unchecked_base_model import UncheckedBaseModel +from .contact_reply_base_request_reply_options_item import ContactReplyBaseRequestReplyOptionsItem class ContactReplyBaseRequest(UncheckedBaseModel): @@ -25,6 +26,11 @@ class ContactReplyBaseRequest(UncheckedBaseModel): A list of image URLs that will be added as attachments. You can include up to 10 URLs. """ + reply_options: typing.Optional[typing.List[ContactReplyBaseRequestReplyOptionsItem]] = pydantic.Field(default=None) + """ + The quick reply selection the contact wishes to respond with. These map to buttons displayed in the Messenger UI if sent by a bot, or the reply options sent by an Admin via the API. + """ + if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 else: diff --git a/src/intercom/types/event.py b/src/intercom/types/contact_reply_base_request_reply_options_item.py similarity index 59% rename from src/intercom/types/event.py rename to src/intercom/types/contact_reply_base_request_reply_options_item.py index 96d58e4..99bc835 100644 --- a/src/intercom/types/event.py +++ b/src/intercom/types/contact_reply_base_request_reply_options_item.py @@ -3,18 +3,21 @@ import typing import pydantic +import typing_extensions from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.serialization import FieldMetadata from ..core.unchecked_base_model import UncheckedBaseModel -class Event(UncheckedBaseModel): +class ContactReplyBaseRequestReplyOptionsItem(UncheckedBaseModel): + text: str = pydantic.Field() """ - The event object enables Intercom to know more about the actions that took place in your app. Currently, you can only tell us when an app's flow has been completed. + The text of the chosen reply option. """ - type: typing.Literal["completed"] = pydantic.Field(default="completed") + uuid_: typing_extensions.Annotated[str, FieldMetadata(alias="uuid")] = pydantic.Field() """ - What action took place. The only value currently accepted is `completed`. + The unique identifier for the quick reply option selected. """ if IS_PYDANTIC_V2: diff --git a/src/intercom/types/contact_segments.py b/src/intercom/types/contact_segments.py index 48d5a1b..9431191 100644 --- a/src/intercom/types/contact_segments.py +++ b/src/intercom/types/contact_segments.py @@ -13,12 +13,12 @@ class ContactSegments(UncheckedBaseModel): A list of segments objects attached to a specific contact. """ - type: typing.Literal["list"] = pydantic.Field(default="list") + type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None) """ The type of the object """ - data: typing.List[Segment] = pydantic.Field() + data: typing.Optional[typing.List[Segment]] = pydantic.Field(default=None) """ Segment objects associated with the contact. """ diff --git a/src/intercom/types/contact_social_profiles.py b/src/intercom/types/contact_social_profiles.py index 946c8c1..c00fb2a 100644 --- a/src/intercom/types/contact_social_profiles.py +++ b/src/intercom/types/contact_social_profiles.py @@ -13,7 +13,7 @@ class ContactSocialProfiles(UncheckedBaseModel): An object containing social profiles that a contact has. """ - data: typing.List[SocialProfile] = pydantic.Field() + data: typing.Optional[typing.List[SocialProfile]] = pydantic.Field(default=None) """ A list of social profiles objects associated with the contact. """ diff --git a/src/intercom/types/contact_subscription_types.py b/src/intercom/types/contact_subscription_types.py index ae348c9..a075e34 100644 --- a/src/intercom/types/contact_subscription_types.py +++ b/src/intercom/types/contact_subscription_types.py @@ -13,22 +13,22 @@ class ContactSubscriptionTypes(UncheckedBaseModel): An object containing Subscription Types meta data about the SubscriptionTypes that a contact has. """ - data: typing.List[AddressableList] = pydantic.Field() + data: typing.Optional[typing.List[AddressableList]] = pydantic.Field(default=None) """ This object represents the subscriptions attached to a contact. """ - url: str = pydantic.Field() + url: typing.Optional[str] = pydantic.Field(default=None) """ Url to get more subscription type resources for this contact """ - total_count: int = pydantic.Field() + total_count: typing.Optional[int] = pydantic.Field(default=None) """ Int representing the total number of subscription types attached to this contact """ - has_more: bool = pydantic.Field() + has_more: typing.Optional[bool] = pydantic.Field(default=None) """ Whether there's more Addressable Objects to be viewed. If true, use the url to view all """ diff --git a/src/intercom/types/contact_tags.py b/src/intercom/types/contact_tags.py index 5a94714..5f90ba3 100644 --- a/src/intercom/types/contact_tags.py +++ b/src/intercom/types/contact_tags.py @@ -13,22 +13,22 @@ class ContactTags(UncheckedBaseModel): An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more. """ - data: typing.List[AddressableList] = pydantic.Field() + data: typing.Optional[typing.List[AddressableList]] = pydantic.Field(default=None) """ This object represents the tags attached to a contact. """ - url: str = pydantic.Field() + url: typing.Optional[str] = pydantic.Field(default=None) """ url to get more tag resources for this contact """ - total_count: int = pydantic.Field() + total_count: typing.Optional[int] = pydantic.Field(default=None) """ Int representing the total number of tags attached to this contact """ - has_more: bool = pydantic.Field() + has_more: typing.Optional[bool] = pydantic.Field(default=None) """ Whether there's more Addressable Objects to be viewed. If true, use the url to view all """ diff --git a/src/intercom/types/contact_unarchived.py b/src/intercom/types/contact_unarchived.py index 38fac21..b194e9f 100644 --- a/src/intercom/types/contact_unarchived.py +++ b/src/intercom/types/contact_unarchived.py @@ -4,30 +4,15 @@ import pydantic from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from ..core.unchecked_base_model import UncheckedBaseModel +from .contact_reference import ContactReference -class ContactUnarchived(UncheckedBaseModel): +class ContactUnarchived(ContactReference): """ unarchived contact object """ - type: typing.Literal["contact"] = pydantic.Field(default="contact") - """ - always contact - """ - - id: str = pydantic.Field() - """ - The unique identifier for the contact which is given by Intercom. - """ - - external_id: typing.Optional[str] = pydantic.Field(default=None) - """ - The unique identifier for the contact which is provided by the Client. - """ - - archived: bool = pydantic.Field() + archived: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the contact is archived or not. """ diff --git a/src/intercom/types/content_object.py b/src/intercom/types/content_object.py deleted file mode 100644 index 857f544..0000000 --- a/src/intercom/types/content_object.py +++ /dev/null @@ -1,30 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from ..core.unchecked_base_model import UncheckedBaseModel -from .component import Component - - -class ContentObject(UncheckedBaseModel): - """ - The content object is where you specify the UI of your app. You provide us with a set of `components` in a components array that we then render. - - The content object should usually be returned within the [canvas object](https://developers.intercom.com/docs/references/canvas-kit/responseobjects/canvas). If you're responding to a Live Canvas request however, then you should only respond with the content object. - """ - - components: typing.List[Component] = pydantic.Field() - """ - The list of components to be rendered. - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/intercom/types/content_sources_list.py b/src/intercom/types/content_sources_list.py index 14cdd1c..62f2eb1 100644 --- a/src/intercom/types/content_sources_list.py +++ b/src/intercom/types/content_sources_list.py @@ -9,13 +9,13 @@ class ContentSourcesList(UncheckedBaseModel): - type: typing.Literal["content_source.list"] = "content_source.list" - total_count: int = pydantic.Field() + type: typing.Optional[typing.Literal["content_source.list"]] = None + total_count: typing.Optional[int] = pydantic.Field(default=None) """ The total number of content sources used by AI Agent in the conversation. """ - content_sources: typing.List[ContentSource] = pydantic.Field() + content_sources: typing.Optional[typing.List[ContentSource]] = pydantic.Field(default=None) """ The content sources used by AI Agent in the conversation. """ diff --git a/src/intercom/types/context.py b/src/intercom/types/context.py deleted file mode 100644 index 25e0f59..0000000 --- a/src/intercom/types/context.py +++ /dev/null @@ -1,55 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -from ..core.unchecked_base_model import UncheckedBaseModel -from .context_location import ContextLocation - - -class Context(UncheckedBaseModel): - """ - The context object provides additional details on where the app has been added (or is currently being used), what page the app is being used on, and information on the Messenger settings. This is in order for you give a fully customised experience based on the customers use case. - - If the `location` is `conversation` then you will also be given a `conversation_id`. If you need to use details about the conversation, then you have to use the `conversation_id` to [make a call to our Conversations API and retrieve the conversation object](https://developers.intercom.com/intercom-api-reference/reference#get-a-single-conversation). - """ - - conversation_id: typing.Optional[int] = pydantic.Field(default=None) - """ - The id of the conversation where the app is added or being used. - """ - - location: typing.Optional[ContextLocation] = pydantic.Field(default=None) - """ - Where the app is added or the action took place. Can be either 'conversation', 'home', 'message', or 'operator'. - """ - - locale: typing.Optional[str] = pydantic.Field(default=None) - """ - The default end-user language of the Messenger. Use to localise Messenger App content. - """ - - messenger_action_colour: typing.Optional[str] = pydantic.Field(default=None) - """ - The messengers action colour. Use in Sheets and Icons to make a Messenger App experience feel part of the host Messenger. - """ - - messenger_background_colour: typing.Optional[str] = pydantic.Field(default=None) - """ - The messengers background colour. Use in Sheets and Icons to make a Messenger App experience feel part of the host Messenger. - """ - - referrer: typing.Optional[str] = pydantic.Field(default=None) - """ - The current page URL where the app is being used. - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/intercom/types/context_location.py b/src/intercom/types/context_location.py deleted file mode 100644 index f416a3b..0000000 --- a/src/intercom/types/context_location.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -ContextLocation = typing.Union[typing.Literal["conversation", "home", "message", "operator"], typing.Any] diff --git a/src/intercom/types/conversation_attachment_files.py b/src/intercom/types/conversation_attachment_files.py index 97f5197..92970bc 100644 --- a/src/intercom/types/conversation_attachment_files.py +++ b/src/intercom/types/conversation_attachment_files.py @@ -12,17 +12,17 @@ class ConversationAttachmentFiles(UncheckedBaseModel): Properties of the attachment files in a conversation part """ - content_type: str = pydantic.Field() + content_type: typing.Optional[str] = pydantic.Field(default=None) """ The content type of the file """ - data: str = pydantic.Field() + data: typing.Optional[str] = pydantic.Field(default=None) """ The base64 encoded file data. """ - name: str = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The name of the file. """ diff --git a/src/intercom/types/conversation_attribute_updated_by_admin.py b/src/intercom/types/conversation_attribute_updated_by_admin.py new file mode 100644 index 0000000..13873aa --- /dev/null +++ b/src/intercom/types/conversation_attribute_updated_by_admin.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.unchecked_base_model import UncheckedBaseModel +from .conversation_attribute_updated_by_admin_attribute import ConversationAttributeUpdatedByAdminAttribute +from .conversation_attribute_updated_by_admin_value import ConversationAttributeUpdatedByAdminValue + + +class ConversationAttributeUpdatedByAdmin(UncheckedBaseModel): + """ + Contains details about Custom Data Attributes (CDAs) that were modified by an admin (operator) for conversation part typeconversation_attribute_updated_by_admin.
+ """
+
+ attribute: typing.Optional[ConversationAttributeUpdatedByAdminAttribute] = None
+ value: typing.Optional[ConversationAttributeUpdatedByAdminValue] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/url_action_component.py b/src/intercom/types/conversation_attribute_updated_by_admin_attribute.py
similarity index 73%
rename from src/intercom/types/url_action_component.py
rename to src/intercom/types/conversation_attribute_updated_by_admin_attribute.py
index 7c961fe..c0d761f 100644
--- a/src/intercom/types/url_action_component.py
+++ b/src/intercom/types/conversation_attribute_updated_by_admin_attribute.py
@@ -7,14 +7,10 @@
from ..core.unchecked_base_model import UncheckedBaseModel
-class UrlActionComponent(UncheckedBaseModel):
+class ConversationAttributeUpdatedByAdminAttribute(UncheckedBaseModel):
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
- A URL action opens a given link in a new browser tab.
- """
-
- url: str = pydantic.Field()
- """
- The link you want to open.
+ Name of the CDA updated
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/submit_action_component.py b/src/intercom/types/conversation_attribute_updated_by_admin_value.py
similarity index 63%
rename from src/intercom/types/submit_action_component.py
rename to src/intercom/types/conversation_attribute_updated_by_admin_value.py
index ea5788f..ee5cd5f 100644
--- a/src/intercom/types/submit_action_component.py
+++ b/src/intercom/types/conversation_attribute_updated_by_admin_value.py
@@ -7,9 +7,10 @@
from ..core.unchecked_base_model import UncheckedBaseModel
-class SubmitActionComponent(UncheckedBaseModel):
+class ConversationAttributeUpdatedByAdminValue(UncheckedBaseModel):
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
- A submit action triggers a [Submit Request](https://developers.intercom.com/docs/canvas-kit#submit-request) to be sent. This request will include all values which have been entered into all the interactive components on the current canvas.
+ Value of the CDA updated
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/conversation_attribute_updated_by_workflow.py b/src/intercom/types/conversation_attribute_updated_by_workflow.py
new file mode 100644
index 0000000..c33ff98
--- /dev/null
+++ b/src/intercom/types/conversation_attribute_updated_by_workflow.py
@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .conversation_attribute_updated_by_workflow_attribute import ConversationAttributeUpdatedByWorkflowAttribute
+from .conversation_attribute_updated_by_workflow_value import ConversationAttributeUpdatedByWorkflowValue
+from .conversation_attribute_updated_by_workflow_workflow import ConversationAttributeUpdatedByWorkflowWorkflow
+
+
+class ConversationAttributeUpdatedByWorkflow(UncheckedBaseModel):
+ """
+ Contains details about the workflow that was triggered and any Custom Data Attributes (CDAs) that were modified during the workflow execution for conversation part type conversation_attribute_updated_by_workflow.
+ """
+
+ workflow: typing.Optional[ConversationAttributeUpdatedByWorkflowWorkflow] = None
+ attribute: typing.Optional[ConversationAttributeUpdatedByWorkflowAttribute] = None
+ value: typing.Optional[ConversationAttributeUpdatedByWorkflowValue] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/configure_response_canvas.py b/src/intercom/types/conversation_attribute_updated_by_workflow_attribute.py
similarity index 63%
rename from src/intercom/types/configure_response_canvas.py
rename to src/intercom/types/conversation_attribute_updated_by_workflow_attribute.py
index ee41462..86730a0 100644
--- a/src/intercom/types/configure_response_canvas.py
+++ b/src/intercom/types/conversation_attribute_updated_by_workflow_attribute.py
@@ -5,13 +5,12 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
-from .canvas_object import CanvasObject
-class ConfigureResponseCanvas(UncheckedBaseModel):
- canvas: CanvasObject = pydantic.Field()
+class ConversationAttributeUpdatedByWorkflowAttribute(UncheckedBaseModel):
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
- The canvas object that defines the new UI to be shown. This will replace the previous canvas that was visible until the teammate interacted with your app.
+ Name of the CDA updated
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/conversation_attribute_updated_by_workflow_value.py b/src/intercom/types/conversation_attribute_updated_by_workflow_value.py
new file mode 100644
index 0000000..461e4ec
--- /dev/null
+++ b/src/intercom/types/conversation_attribute_updated_by_workflow_value.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ConversationAttributeUpdatedByWorkflowValue(UncheckedBaseModel):
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Value of the CDA updated
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/conversation_attribute_updated_by_workflow_workflow.py b/src/intercom/types/conversation_attribute_updated_by_workflow_workflow.py
new file mode 100644
index 0000000..445eb7f
--- /dev/null
+++ b/src/intercom/types/conversation_attribute_updated_by_workflow_workflow.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ConversationAttributeUpdatedByWorkflowWorkflow(UncheckedBaseModel):
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Name of the workflow
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/conversation_contacts.py b/src/intercom/types/conversation_contacts.py
index 450c24a..a216f92 100644
--- a/src/intercom/types/conversation_contacts.py
+++ b/src/intercom/types/conversation_contacts.py
@@ -13,8 +13,12 @@ class ConversationContacts(UncheckedBaseModel):
The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.
"""
- type: typing.Literal["contact.list"] = "contact.list"
- contacts: typing.List[ContactReference] = pydantic.Field()
+ type: typing.Optional[typing.Literal["contact.list"]] = pydantic.Field(default=None)
+ """
+
+ """
+
+ contacts: typing.Optional[typing.List[ContactReference]] = pydantic.Field(default=None)
"""
The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.
"""
diff --git a/src/intercom/types/divider_component.py b/src/intercom/types/conversation_deleted.py
similarity index 62%
rename from src/intercom/types/divider_component.py
rename to src/intercom/types/conversation_deleted.py
index ef729f1..07b8a1c 100644
--- a/src/intercom/types/divider_component.py
+++ b/src/intercom/types/conversation_deleted.py
@@ -7,19 +7,24 @@
from ..core.unchecked_base_model import UncheckedBaseModel
-class DividerComponent(UncheckedBaseModel):
+class ConversationDeleted(UncheckedBaseModel):
"""
- A divider component is used to separate components with a line.
+ deleted conversation object
"""
id: typing.Optional[str] = pydantic.Field(default=None)
"""
- A unique identifier for the component.
+ The unique identifier for the conversation.
"""
- bottom_margin: typing.Optional[typing.Literal["none"]] = pydantic.Field(default=None)
+ object: typing.Optional[typing.Literal["conversation"]] = pydantic.Field(default=None)
"""
- Disables a component's margin-bottom of 10px.
+ always conversation
+ """
+
+ deleted: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Whether the conversation is deleted or not.
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/conversation_first_contact_reply.py b/src/intercom/types/conversation_first_contact_reply.py
index 7963edd..f158081 100644
--- a/src/intercom/types/conversation_first_contact_reply.py
+++ b/src/intercom/types/conversation_first_contact_reply.py
@@ -12,12 +12,12 @@ class ConversationFirstContactReply(UncheckedBaseModel):
An object containing information on the first users message. For a contact initiated message this will represent the users original message.
"""
- created_at: int = pydantic.Field()
+ created_at: typing.Optional[int] = pydantic.Field(default=None)
"""
"""
- type: str = pydantic.Field()
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
"""
diff --git a/src/intercom/types/paginated_conversation_response.py b/src/intercom/types/conversation_list.py
similarity index 77%
rename from src/intercom/types/paginated_conversation_response.py
rename to src/intercom/types/conversation_list.py
index d07c35d..5fad7df 100644
--- a/src/intercom/types/paginated_conversation_response.py
+++ b/src/intercom/types/conversation_list.py
@@ -9,22 +9,22 @@
from .cursor_pages import CursorPages
-class PaginatedConversationResponse(UncheckedBaseModel):
+class ConversationList(UncheckedBaseModel):
"""
Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.
"""
- type: typing.Literal["conversation.list"] = pydantic.Field(default="conversation.list")
+ type: typing.Optional[typing.Literal["conversation.list"]] = pydantic.Field(default=None)
"""
Always conversation.list
"""
- conversations: typing.List[Conversation] = pydantic.Field()
+ conversations: typing.Optional[typing.List[Conversation]] = pydantic.Field(default=None)
"""
The list of conversation objects
"""
- total_count: int = pydantic.Field()
+ total_count: typing.Optional[int] = pydantic.Field(default=None)
"""
A count of the total number of objects.
"""
diff --git a/src/intercom/types/conversation_part.py b/src/intercom/types/conversation_part.py
index 152337e..2766f48 100644
--- a/src/intercom/types/conversation_part.py
+++ b/src/intercom/types/conversation_part.py
@@ -5,7 +5,12 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
+from ..tags.types.tag_basic import TagBasic
from .conversation_part_author import ConversationPartAuthor
+from .conversation_part_metadata import ConversationPartMetadata
+from .conversation_part_state import ConversationPartState
+from .email_message_metadata import EmailMessageMetadata
+from .event_details import EventDetails
from .part_attachment import PartAttachment
from .reference import Reference
@@ -15,17 +20,17 @@ class ConversationPart(UncheckedBaseModel):
A Conversation Part represents a message in the conversation.
"""
- type: typing.Literal["conversation_part"] = pydantic.Field(default="conversation_part")
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
Always conversation_part
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The id representing the conversation part.
"""
- part_type: str = pydantic.Field()
+ part_type: typing.Optional[str] = pydantic.Field(default=None)
"""
The type of conversation part.
"""
@@ -35,7 +40,7 @@ class ConversationPart(UncheckedBaseModel):
The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.
"""
- created_at: int = pydantic.Field()
+ created_at: typing.Optional[int] = pydantic.Field(default=None)
"""
The time the conversation part was created.
"""
@@ -45,7 +50,7 @@ class ConversationPart(UncheckedBaseModel):
The last time the conversation part was updated.
"""
- notified_at: int = pydantic.Field()
+ notified_at: typing.Optional[int] = pydantic.Field(default=None)
"""
The time the user was notified with the conversation part.
"""
@@ -55,7 +60,7 @@ class ConversationPart(UncheckedBaseModel):
The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)
"""
- author: ConversationPartAuthor
+ author: typing.Optional[ConversationPartAuthor] = None
attachments: typing.Optional[typing.List[PartAttachment]] = pydantic.Field(default=None)
"""
A list of attachments for the part.
@@ -66,11 +71,29 @@ class ConversationPart(UncheckedBaseModel):
The external id of the conversation part
"""
- redacted: bool = pydantic.Field()
+ redacted: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether or not the conversation part has been redacted.
"""
+ email_message_metadata: typing.Optional[EmailMessageMetadata] = None
+ metadata: typing.Optional[ConversationPartMetadata] = None
+ state: typing.Optional[ConversationPartState] = pydantic.Field(default=None)
+ """
+ Indicates the current state of conversation when the conversation part was created.
+ """
+
+ tags: typing.Optional[typing.List[TagBasic]] = pydantic.Field(default=None)
+ """
+ A list of tags objects associated with the conversation part.
+ """
+
+ event_details: typing.Optional[EventDetails] = None
+ app_package_code: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The app package code if this part was created via API. null if the part was not created via API.
+ """
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/src/intercom/types/conversation_part_author.py b/src/intercom/types/conversation_part_author.py
index bcfeafb..3af9b14 100644
--- a/src/intercom/types/conversation_part_author.py
+++ b/src/intercom/types/conversation_part_author.py
@@ -12,26 +12,36 @@ class ConversationPartAuthor(UncheckedBaseModel):
The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.
"""
- type: str = pydantic.Field()
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
The type of the author
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The id of the author
"""
- name: str = pydantic.Field()
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
The name of the author
"""
- email: str = pydantic.Field()
+ email: typing.Optional[str] = pydantic.Field(default=None)
"""
The email of the author
"""
+ from_ai_agent: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ If this conversation part was sent by the AI Agent
+ """
+
+ is_ai_answer: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ If this conversation part body was generated by the AI Agent
+ """
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/src/intercom/types/conversation_part_metadata.py b/src/intercom/types/conversation_part_metadata.py
new file mode 100644
index 0000000..2b31b86
--- /dev/null
+++ b/src/intercom/types/conversation_part_metadata.py
@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .conversation_part_metadata_quick_reply_options_item import ConversationPartMetadataQuickReplyOptionsItem
+
+
+class ConversationPartMetadata(UncheckedBaseModel):
+ """
+ Metadata for a conversation part
+ """
+
+ quick_reply_options: typing.Optional[typing.List[ConversationPartMetadataQuickReplyOptionsItem]] = pydantic.Field(
+ default=None
+ )
+ """
+ The quick reply options sent by the Admin or bot, presented in this conversation part.
+ """
+
+ quick_reply_uuid: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The unique identifier for the quick reply option that was clicked by the end user.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/conversation_part_metadata_quick_reply_options_item.py b/src/intercom/types/conversation_part_metadata_quick_reply_options_item.py
new file mode 100644
index 0000000..ccfe697
--- /dev/null
+++ b/src/intercom/types/conversation_part_metadata_quick_reply_options_item.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from .quick_reply_option import QuickReplyOption
+
+
+class ConversationPartMetadataQuickReplyOptionsItem(QuickReplyOption):
+ translations: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+ """
+ The translations for the quick reply option.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/conversation_part_state.py b/src/intercom/types/conversation_part_state.py
new file mode 100644
index 0000000..96342fb
--- /dev/null
+++ b/src/intercom/types/conversation_part_state.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ConversationPartState = typing.Union[typing.Literal["open", "closed", "snoozed"], typing.Any]
diff --git a/src/intercom/types/conversation_parts.py b/src/intercom/types/conversation_parts.py
index f3e3374..e7f31bd 100644
--- a/src/intercom/types/conversation_parts.py
+++ b/src/intercom/types/conversation_parts.py
@@ -13,17 +13,17 @@ class ConversationParts(UncheckedBaseModel):
A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.
"""
- type: typing.Literal["conversation_part.list"] = pydantic.Field(default="conversation_part.list")
+ type: typing.Optional[typing.Literal["conversation_part.list"]] = pydantic.Field(default=None)
"""
"""
- conversation_parts: typing.List[ConversationPart] = pydantic.Field()
+ conversation_parts: typing.Optional[typing.List[ConversationPart]] = pydantic.Field(default=None)
"""
A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.
"""
- total_count: int = pydantic.Field()
+ total_count: typing.Optional[int] = pydantic.Field(default=None)
"""
"""
diff --git a/src/intercom/types/conversation_rating.py b/src/intercom/types/conversation_rating.py
index fd76822..8f3a608 100644
--- a/src/intercom/types/conversation_rating.py
+++ b/src/intercom/types/conversation_rating.py
@@ -14,23 +14,28 @@ class ConversationRating(UncheckedBaseModel):
The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.
"""
- rating: int = pydantic.Field()
+ rating: typing.Optional[int] = pydantic.Field(default=None)
"""
The rating, between 1 and 5, for the conversation.
"""
- remark: str = pydantic.Field()
+ remark: typing.Optional[str] = pydantic.Field(default=None)
"""
An optional field to add a remark to correspond to the number rating
"""
- created_at: int = pydantic.Field()
+ created_at: typing.Optional[int] = pydantic.Field(default=None)
"""
The time the rating was requested in the conversation being rated.
"""
- contact: ContactReference
- teammate: Reference
+ updated_at: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ The time the rating was last updated.
+ """
+
+ contact: typing.Optional[ContactReference] = None
+ teammate: typing.Optional[Reference] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/intercom/types/dropdown_option.py b/src/intercom/types/conversation_response_time.py
similarity index 53%
rename from src/intercom/types/dropdown_option.py
rename to src/intercom/types/conversation_response_time.py
index 324abfa..e0e3389 100644
--- a/src/intercom/types/dropdown_option.py
+++ b/src/intercom/types/conversation_response_time.py
@@ -7,29 +7,24 @@
from ..core.unchecked_base_model import UncheckedBaseModel
-class DropdownOption(UncheckedBaseModel):
+class ConversationResponseTime(UncheckedBaseModel):
"""
- A dropdown option component that can be selected.
+ Details of first response time of assigned team in seconds.
"""
- type: typing.Literal["option"] = pydantic.Field(default="option")
+ team_id: typing.Optional[int] = pydantic.Field(default=None)
"""
- The type of component you are rendering.
+ Id of the assigned team.
"""
- id: str = pydantic.Field()
+ team_name: typing.Optional[str] = pydantic.Field(default=None)
"""
- A unique identifier for the option.
+ Name of the assigned Team, null if team does not exist, Unassigned if no team is assigned.
"""
- text: str = pydantic.Field()
+ response_time: typing.Optional[int] = pydantic.Field(default=None)
"""
- The text shown within this option.
- """
-
- disabled: typing.Optional[bool] = pydantic.Field(default=None)
- """
- Styles the option and prevents the action. Default is false.
+ First response time of assigned team in seconds.
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/conversation_source.py b/src/intercom/types/conversation_source.py
index b016f53..31a365d 100644
--- a/src/intercom/types/conversation_source.py
+++ b/src/intercom/types/conversation_source.py
@@ -12,25 +12,25 @@
class ConversationSource(UncheckedBaseModel):
"""
- The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated.
+ The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated.
"""
- type: ConversationSourceType = pydantic.Field()
+ type: typing.Optional[ConversationSourceType] = pydantic.Field(default=None)
"""
This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp.
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The id representing the message.
"""
- delivered_as: str = pydantic.Field()
+ delivered_as: typing.Optional[str] = pydantic.Field(default=None)
"""
The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email).
"""
- subject: str = pydantic.Field()
+ subject: typing.Optional[str] = pydantic.Field(default=None)
"""
Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured.
"""
@@ -40,7 +40,7 @@ class ConversationSource(UncheckedBaseModel):
The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.
"""
- author: ConversationPartAuthor
+ author: typing.Optional[ConversationPartAuthor] = None
attachments: typing.Optional[typing.List[PartAttachment]] = pydantic.Field(default=None)
"""
A list of attachments for the part.
@@ -51,7 +51,7 @@ class ConversationSource(UncheckedBaseModel):
The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.
"""
- redacted: bool = pydantic.Field()
+ redacted: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether or not the source message has been redacted. Only applicable for contact initiated messages.
"""
diff --git a/src/intercom/types/conversation_statistics.py b/src/intercom/types/conversation_statistics.py
index 4e65607..d44cbf6 100644
--- a/src/intercom/types/conversation_statistics.py
+++ b/src/intercom/types/conversation_statistics.py
@@ -5,6 +5,7 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
+from .conversation_response_time import ConversationResponseTime
class ConversationStatistics(UncheckedBaseModel):
@@ -12,7 +13,7 @@ class ConversationStatistics(UncheckedBaseModel):
A Statistics object containing all information required for reporting, with timestamps and calculated metrics.
"""
- type: typing.Literal["conversation_statistics"] = pydantic.Field(default="conversation_statistics")
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
"""
@@ -107,6 +108,25 @@ class ConversationStatistics(UncheckedBaseModel):
Total number of conversation parts.
"""
+ assigned_team_first_response_time_by_team: typing.Optional[typing.List[ConversationResponseTime]] = pydantic.Field(
+ default=None
+ )
+ """
+ An array of conversation response time objects
+ """
+
+ assigned_team_first_response_time_in_office_hours: typing.Optional[typing.List[ConversationResponseTime]] = (
+ pydantic.Field(default=None)
+ )
+ """
+ An array of conversation response time objects within office hours
+ """
+
+ handling_time: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ Time from conversation assignment to conversation close in seconds.
+ """
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/src/intercom/types/create_article_request.py b/src/intercom/types/create_article_request.py
new file mode 100644
index 0000000..83428ff
--- /dev/null
+++ b/src/intercom/types/create_article_request.py
@@ -0,0 +1,62 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .article_translated_content import ArticleTranslatedContent
+from .create_article_request_parent_type import CreateArticleRequestParentType
+from .create_article_request_state import CreateArticleRequestState
+
+
+class CreateArticleRequest(UncheckedBaseModel):
+ """
+ You can create an Article
+ """
+
+ title: str = pydantic.Field()
+ """
+ The title of the article.For multilingual articles, this will be the title of the default language's content.
+ """
+
+ description: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The description of the article. For multilingual articles, this will be the description of the default language's content.
+ """
+
+ body: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The content of the article. For multilingual articles, this will be the body of the default language's content.
+ """
+
+ author_id: int = pydantic.Field()
+ """
+ The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.
+ """
+
+ state: typing.Optional[CreateArticleRequestState] = pydantic.Field(default=None)
+ """
+ Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.
+ """
+
+ parent_id: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ The id of the article's parent collection or section. An article without this field stands alone.
+ """
+
+ parent_type: typing.Optional[CreateArticleRequestParentType] = pydantic.Field(default=None)
+ """
+ The type of parent, which can either be a `collection` or `section`.
+ """
+
+ translated_content: typing.Optional[ArticleTranslatedContent] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/articles/types/create_article_request_parent_type.py b/src/intercom/types/create_article_request_parent_type.py
similarity index 100%
rename from src/intercom/articles/types/create_article_request_parent_type.py
rename to src/intercom/types/create_article_request_parent_type.py
diff --git a/src/intercom/articles/types/create_article_request_state.py b/src/intercom/types/create_article_request_state.py
similarity index 100%
rename from src/intercom/articles/types/create_article_request_state.py
rename to src/intercom/types/create_article_request_state.py
diff --git a/src/intercom/types/create_data_attribute_request.py b/src/intercom/types/create_data_attribute_request.py
new file mode 100644
index 0000000..cd76eee
--- /dev/null
+++ b/src/intercom/types/create_data_attribute_request.py
@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .create_data_attribute_request_one import CreateDataAttributeRequestOne
+from .create_data_attribute_request_options import CreateDataAttributeRequestOptions
+
+CreateDataAttributeRequest = typing.Union[CreateDataAttributeRequestOptions, CreateDataAttributeRequestOne]
diff --git a/src/intercom/types/create_data_attribute_request_one.py b/src/intercom/types/create_data_attribute_request_one.py
new file mode 100644
index 0000000..1693ecd
--- /dev/null
+++ b/src/intercom/types/create_data_attribute_request_one.py
@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .create_data_attribute_request_one_data_type import CreateDataAttributeRequestOneDataType
+
+
+class CreateDataAttributeRequestOne(UncheckedBaseModel):
+ data_type: typing.Optional[CreateDataAttributeRequestOneDataType] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/data_attributes/types/create_data_attribute_request_data_type.py b/src/intercom/types/create_data_attribute_request_one_data_type.py
similarity index 76%
rename from src/intercom/data_attributes/types/create_data_attribute_request_data_type.py
rename to src/intercom/types/create_data_attribute_request_one_data_type.py
index c2471b7..0689e73 100644
--- a/src/intercom/data_attributes/types/create_data_attribute_request_data_type.py
+++ b/src/intercom/types/create_data_attribute_request_one_data_type.py
@@ -2,6 +2,6 @@
import typing
-CreateDataAttributeRequestDataType = typing.Union[
+CreateDataAttributeRequestOneDataType = typing.Union[
typing.Literal["string", "integer", "float", "boolean", "datetime", "date"], typing.Any
]
diff --git a/src/intercom/types/data_table_component.py b/src/intercom/types/create_data_attribute_request_options.py
similarity index 52%
rename from src/intercom/types/data_table_component.py
rename to src/intercom/types/create_data_attribute_request_options.py
index 0ebe884..4cfcb97 100644
--- a/src/intercom/types/data_table_component.py
+++ b/src/intercom/types/create_data_attribute_request_options.py
@@ -5,17 +5,14 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
-from .data_table_item import DataTableItem
+from .create_data_attribute_request_options_options_item import CreateDataAttributeRequestOptionsOptionsItem
-class DataTableComponent(UncheckedBaseModel):
+class CreateDataAttributeRequestOptions(UncheckedBaseModel):
+ data_type: typing.Optional[typing.Literal["options"]] = None
+ options: typing.List[CreateDataAttributeRequestOptionsOptionsItem] = pydantic.Field()
"""
- A data-table component is used for rendering a table of key-value pairs. For Messenger, text will wrap around on multiple lines. For Inbox and Frame (ie. Configure) views, we will truncate and use tooltips on hover if the text overflows.
- """
-
- items: typing.List[DataTableItem] = pydantic.Field()
- """
- The items that will be rendered in the data-table.
+ Array of objects representing the options of the list, with `value` as the key and the option as the value. At least two options are required.
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/create_data_attribute_request_options_options_item.py b/src/intercom/types/create_data_attribute_request_options_options_item.py
new file mode 100644
index 0000000..e879b4f
--- /dev/null
+++ b/src/intercom/types/create_data_attribute_request_options_options_item.py
@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class CreateDataAttributeRequestOptionsOptionsItem(UncheckedBaseModel):
+ value: typing.Optional[str] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/create_internal_article_request.py b/src/intercom/types/create_internal_article_request.py
new file mode 100644
index 0000000..8a26987
--- /dev/null
+++ b/src/intercom/types/create_internal_article_request.py
@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class CreateInternalArticleRequest(UncheckedBaseModel):
+ """
+ You can create an Internal Article
+ """
+
+ title: str = pydantic.Field()
+ """
+ The title of the article.
+ """
+
+ body: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The content of the article.
+ """
+
+ author_id: int = pydantic.Field()
+ """
+ The id of the author of the article.
+ """
+
+ owner_id: int = pydantic.Field()
+ """
+ The id of the owner of the article.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/create_or_update_company_request.py b/src/intercom/types/create_or_update_company_request.py
new file mode 100644
index 0000000..88f9557
--- /dev/null
+++ b/src/intercom/types/create_or_update_company_request.py
@@ -0,0 +1,67 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class CreateOrUpdateCompanyRequest(UncheckedBaseModel):
+ """
+ You can create or update a Company
+ """
+
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The name of the Company
+ """
+
+ company_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The company id you have defined for the company. Can't be updated
+ """
+
+ plan: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The name of the plan you have associated with the company.
+ """
+
+ size: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ The number of employees in this company.
+ """
+
+ website: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.
+ """
+
+ industry: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The industry that this company operates in.
+ """
+
+ custom_attributes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+ """
+ A hash of key/value pairs containing any other data about the company you want Intercom to store.
+ """
+
+ remote_created_at: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ The time the company was created by you.
+ """
+
+ monthly_spend: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647..
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/sheet_action_component.py b/src/intercom/types/create_phone_switch_request.py
similarity index 61%
rename from src/intercom/types/sheet_action_component.py
rename to src/intercom/types/create_phone_switch_request.py
index 656bd49..988e85d 100644
--- a/src/intercom/types/sheet_action_component.py
+++ b/src/intercom/types/create_phone_switch_request.py
@@ -5,20 +5,21 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
+from .custom_attributes import CustomAttributes
-class SheetActionComponent(UncheckedBaseModel):
+class CreatePhoneSwitchRequest(UncheckedBaseModel):
"""
- A sheet action opens the link you give within the Messenger as an embedded iframe.
-
- [More on how Sheets work is in our Canvas Kit documentation.](https://developers.intercom.com/docs/canvas-kit#sheets-optional)
+ You can create an phone switch
"""
- url: str = pydantic.Field()
+ phone: str = pydantic.Field()
"""
- The link which hosts your sheet.
+ Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger.
"""
+ custom_attributes: typing.Optional[CustomAttributes] = None
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/src/intercom/types/create_ticket_request_assignment.py b/src/intercom/types/create_ticket_request_assignment.py
new file mode 100644
index 0000000..8c70618
--- /dev/null
+++ b/src/intercom/types/create_ticket_request_assignment.py
@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class CreateTicketRequestAssignment(UncheckedBaseModel):
+ admin_assignee_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The ID of the admin to which the ticket is assigned. If not provided, the ticket will be unassigned.
+ """
+
+ team_assignee_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The ID of the team to which the ticket is assigned. If not provided, the ticket will be unassigned.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/create_ticket_request.py b/src/intercom/types/create_ticket_request_body.py
similarity index 66%
rename from src/intercom/types/create_ticket_request.py
rename to src/intercom/types/create_ticket_request_body.py
index abee343..7680a22 100644
--- a/src/intercom/types/create_ticket_request.py
+++ b/src/intercom/types/create_ticket_request_body.py
@@ -5,11 +5,11 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
+from .create_ticket_request_assignment import CreateTicketRequestAssignment
from .create_ticket_request_contacts_item import CreateTicketRequestContactsItem
-from .ticket_request_custom_attributes import TicketRequestCustomAttributes
-class CreateTicketRequest(UncheckedBaseModel):
+class CreateTicketRequestBody(UncheckedBaseModel):
"""
You can create a Ticket
"""
@@ -24,9 +24,18 @@ class CreateTicketRequest(UncheckedBaseModel):
The list of contacts (users or leads) affected by this ticket. Currently only one is allowed
"""
+ conversation_to_link_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:
+ - conversation | back-office ticket
+ - customer tickets | non-shared back-office ticket
+ - conversation | tracker ticket
+ - customer ticket | tracker ticket
+ """
+
company_id: typing.Optional[str] = pydantic.Field(default=None)
"""
- The ID of the company that the ticket is associated with. The ID that you set upon company creation.
+ The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom
"""
created_at: typing.Optional[int] = pydantic.Field(default=None)
@@ -34,7 +43,7 @@ class CreateTicketRequest(UncheckedBaseModel):
The time the ticket was created. If not provided, the current time will be used.
"""
- ticket_attributes: typing.Optional[TicketRequestCustomAttributes] = None
+ assignment: typing.Optional[CreateTicketRequestAssignment] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/intercom/types/create_ticket_type_request.py b/src/intercom/types/create_ticket_type_request.py
new file mode 100644
index 0000000..5ce9d1e
--- /dev/null
+++ b/src/intercom/types/create_ticket_type_request.py
@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .create_ticket_type_request_category import CreateTicketTypeRequestCategory
+
+
+class CreateTicketTypeRequest(UncheckedBaseModel):
+ """
+ The request payload for creating a ticket type.
+ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)
+ """
+
+ name: str = pydantic.Field()
+ """
+ The name of the ticket type.
+ """
+
+ description: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The description of the ticket type.
+ """
+
+ category: typing.Optional[CreateTicketTypeRequestCategory] = pydantic.Field(default=None)
+ """
+ Category of the Ticket Type.
+ """
+
+ icon: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The icon of the ticket type.
+ """
+
+ is_internal: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/ticket_types/types/create_ticket_type_request_category.py b/src/intercom/types/create_ticket_type_request_category.py
similarity index 100%
rename from src/intercom/ticket_types/types/create_ticket_type_request_category.py
rename to src/intercom/types/create_ticket_type_request_category.py
diff --git a/src/intercom/types/cursor_pages.py b/src/intercom/types/cursor_pages.py
index 1c27e2e..9877488 100644
--- a/src/intercom/types/cursor_pages.py
+++ b/src/intercom/types/cursor_pages.py
@@ -14,7 +14,7 @@ class CursorPages(UncheckedBaseModel):
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.
"""
- type: typing.Literal["pages"] = pydantic.Field(default="pages")
+ type: typing.Optional[typing.Literal["pages"]] = pydantic.Field(default=None)
"""
the type of object `pages`.
"""
diff --git a/src/intercom/types/custom_action_finished.py b/src/intercom/types/custom_action_finished.py
new file mode 100644
index 0000000..4054d04
--- /dev/null
+++ b/src/intercom/types/custom_action_finished.py
@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .custom_action_finished_action import CustomActionFinishedAction
+
+
+class CustomActionFinished(UncheckedBaseModel):
+ """
+ Contains details about final status of the completed action for conversation part type custom_action_finished.
+ """
+
+ action: typing.Optional[CustomActionFinishedAction] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/current_canvas.py b/src/intercom/types/custom_action_finished_action.py
similarity index 61%
rename from src/intercom/types/current_canvas.py
rename to src/intercom/types/custom_action_finished_action.py
index 9adeb2e..7c05f07 100644
--- a/src/intercom/types/current_canvas.py
+++ b/src/intercom/types/custom_action_finished_action.py
@@ -5,17 +5,18 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
-from .canvas_object import CanvasObject
+from .custom_action_finished_action_result import CustomActionFinishedActionResult
-class CurrentCanvas(UncheckedBaseModel):
+class CustomActionFinishedAction(UncheckedBaseModel):
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
- The current canvas that was most recently showing before the request was sent. This object mirrors the same format as the Canvas Object.
+ Name of the action
"""
- current_canvas: CanvasObject = pydantic.Field()
+ result: typing.Optional[CustomActionFinishedActionResult] = pydantic.Field(default=None)
"""
- The canvas object representing the current canvas state.
+ Status of the action
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/custom_action_finished_action_result.py b/src/intercom/types/custom_action_finished_action_result.py
new file mode 100644
index 0000000..0f1e35a
--- /dev/null
+++ b/src/intercom/types/custom_action_finished_action_result.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CustomActionFinishedActionResult = typing.Union[typing.Literal["success", "failed"], typing.Any]
diff --git a/src/intercom/types/custom_action_started.py b/src/intercom/types/custom_action_started.py
new file mode 100644
index 0000000..de8480e
--- /dev/null
+++ b/src/intercom/types/custom_action_started.py
@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .custom_action_started_action import CustomActionStartedAction
+
+
+class CustomActionStarted(UncheckedBaseModel):
+ """
+ Contains details about name of the action that was initiated for conversation part type custom_action_started.
+ """
+
+ action: typing.Optional[CustomActionStartedAction] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/custom_action_started_action.py b/src/intercom/types/custom_action_started_action.py
new file mode 100644
index 0000000..1bc8192
--- /dev/null
+++ b/src/intercom/types/custom_action_started_action.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class CustomActionStartedAction(UncheckedBaseModel):
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Name of the action
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/custom_attributes.py b/src/intercom/types/custom_attributes.py
index 751b394..52b1b17 100644
--- a/src/intercom/types/custom_attributes.py
+++ b/src/intercom/types/custom_attributes.py
@@ -2,4 +2,6 @@
import typing
-CustomAttributes = typing.Dict[str, typing.Optional[typing.Any]]
+from .custom_attributes_value import CustomAttributesValue
+
+CustomAttributes = typing.Dict[str, CustomAttributesValue]
diff --git a/src/intercom/types/custom_attributes_value.py b/src/intercom/types/custom_attributes_value.py
new file mode 100644
index 0000000..93669f7
--- /dev/null
+++ b/src/intercom/types/custom_attributes_value.py
@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .custom_object_instance_list import CustomObjectInstanceList
+from .datetime import Datetime
+
+CustomAttributesValue = typing.Union[str, int, Datetime, CustomObjectInstanceList]
diff --git a/src/intercom/types/initialize_response.py b/src/intercom/types/custom_channel_attribute.py
similarity index 63%
rename from src/intercom/types/initialize_response.py
rename to src/intercom/types/custom_channel_attribute.py
index b7f9adf..88d3994 100644
--- a/src/intercom/types/initialize_response.py
+++ b/src/intercom/types/custom_channel_attribute.py
@@ -5,17 +5,17 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
-from .canvas_object import CanvasObject
-class InitializeResponse(UncheckedBaseModel):
+class CustomChannelAttribute(UncheckedBaseModel):
+ id: str = pydantic.Field()
"""
- The response object returned when initializing an app, specifying the UI for the first screen using components.
+ Identifier for the attribute being collected.
"""
- canvas: CanvasObject = pydantic.Field()
+ value: str = pydantic.Field()
"""
- The canvas object that defines the UI to be shown for the app.
+ Value provided by the user for the attribute.
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/live_canvas_response.py b/src/intercom/types/custom_channel_base_event.py
similarity index 62%
rename from src/intercom/types/live_canvas_response.py
rename to src/intercom/types/custom_channel_base_event.py
index 4f8d833..3670a05 100644
--- a/src/intercom/types/live_canvas_response.py
+++ b/src/intercom/types/custom_channel_base_event.py
@@ -5,19 +5,22 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
-from .content_object import ContentObject
+from .custom_channel_contact import CustomChannelContact
-class LiveCanvasResponse(UncheckedBaseModel):
+class CustomChannelBaseEvent(UncheckedBaseModel):
+ event_id: str = pydantic.Field()
"""
- The response object returned when responding to a Live Canvas request. This contains the components you want to show.
+ Unique identifier for the event.
"""
- content: ContentObject = pydantic.Field()
+ external_conversation_id: str = pydantic.Field()
"""
- The content object that defines the components to be shown.
+ Identifier for the conversation in your application.
"""
+ contact: CustomChannelContact
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/src/intercom/types/custom_channel_contact.py b/src/intercom/types/custom_channel_contact.py
new file mode 100644
index 0000000..cb1d76b
--- /dev/null
+++ b/src/intercom/types/custom_channel_contact.py
@@ -0,0 +1,39 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .custom_channel_contact_type import CustomChannelContactType
+
+
+class CustomChannelContact(UncheckedBaseModel):
+ type: CustomChannelContactType = pydantic.Field()
+ """
+ Type of contact, must be "user" or "lead".
+ """
+
+ external_id: str = pydantic.Field()
+ """
+ External identifier for the contact. Intercom will take care of the mapping of your external_id with our internal ones so you don't have to worry about it.
+ """
+
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Name of the contact. Required for user type.
+ """
+
+ email: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Email address of the contact. Required for user type.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/custom_channel_contact_type.py b/src/intercom/types/custom_channel_contact_type.py
new file mode 100644
index 0000000..de33161
--- /dev/null
+++ b/src/intercom/types/custom_channel_contact_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CustomChannelContactType = typing.Union[typing.Literal["user", "lead"], typing.Any]
diff --git a/src/intercom/types/single_select_option.py b/src/intercom/types/custom_channel_notification_response.py
similarity index 52%
rename from src/intercom/types/single_select_option.py
rename to src/intercom/types/custom_channel_notification_response.py
index fe2ef03..394f61c 100644
--- a/src/intercom/types/single_select_option.py
+++ b/src/intercom/types/custom_channel_notification_response.py
@@ -7,29 +7,25 @@
from ..core.unchecked_base_model import UncheckedBaseModel
-class SingleSelectOption(UncheckedBaseModel):
+class CustomChannelNotificationResponse(UncheckedBaseModel):
+ external_conversation_id: str = pydantic.Field()
"""
- A single select option component that can be selected.
+ The external conversation ID provided in the notification request
"""
- type: typing.Literal["option"] = pydantic.Field(default="option")
+ conversation_id: str = pydantic.Field()
"""
- The type of component you are rendering.
+ The Intercom conversation ID mapped to the external conversation ID
"""
- id: str = pydantic.Field()
+ external_contact_id: str = pydantic.Field()
"""
- A unique identifier for the option.
+ The external contact ID provided in the notification request
"""
- text: str = pydantic.Field()
+ contact_id: str = pydantic.Field()
"""
- The text shown within this option.
- """
-
- disabled: typing.Optional[bool] = pydantic.Field(default=None)
- """
- Styles the option and prevents the action. Default is false.
+ The Intercom contact ID mapped to the external contact ID
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/custom_object_instance_deleted.py b/src/intercom/types/custom_object_instance_deleted.py
new file mode 100644
index 0000000..5d401bf
--- /dev/null
+++ b/src/intercom/types/custom_object_instance_deleted.py
@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class CustomObjectInstanceDeleted(UncheckedBaseModel):
+ """
+ deleted custom object instance object
+ """
+
+ object: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The unique identifier of the Custom Object type that defines the structure of the Custom Object instance.
+ """
+
+ id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The Intercom defined id representing the Custom Object instance.
+ """
+
+ deleted: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Whether the Custom Object instance is deleted or not.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/custom_object_instance_list.py b/src/intercom/types/custom_object_instance_list.py
new file mode 100644
index 0000000..9cc9735
--- /dev/null
+++ b/src/intercom/types/custom_object_instance_list.py
@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from ..custom_object_instances.types.custom_object_instance import CustomObjectInstance
+
+
+class CustomObjectInstanceList(UncheckedBaseModel):
+ """
+ The list of associated custom object instances for a given reference attribute on the parent object.
+ """
+
+ type: typing.Optional[str] = None
+ instances: typing.Optional[typing.List[typing.Optional[CustomObjectInstance]]] = pydantic.Field(default=None)
+ """
+ The list of associated custom object instances for a given reference attribute on the parent object.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/data_attribute_list.py b/src/intercom/types/data_attribute_list.py
index 5690567..2a7b137 100644
--- a/src/intercom/types/data_attribute_list.py
+++ b/src/intercom/types/data_attribute_list.py
@@ -13,12 +13,12 @@ class DataAttributeList(UncheckedBaseModel):
A list of all data attributes belonging to a workspace for contacts, companies or conversations.
"""
- type: typing.Literal["list"] = pydantic.Field(default="list")
+ type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None)
"""
The type of the object
"""
- data: typing.List[DataAttribute] = pydantic.Field()
+ data: typing.Optional[typing.List[DataAttribute]] = pydantic.Field(default=None)
"""
A list of data attributes
"""
diff --git a/src/intercom/types/data_event_list.py b/src/intercom/types/data_event_list.py
index 1ebe4a5..f69a464 100644
--- a/src/intercom/types/data_event_list.py
+++ b/src/intercom/types/data_event_list.py
@@ -14,12 +14,12 @@ class DataEventList(UncheckedBaseModel):
This will return a list of data events for the App.
"""
- type: typing.Literal["event.list"] = pydantic.Field(default="event.list")
+ type: typing.Optional[typing.Literal["event.list"]] = pydantic.Field(default=None)
"""
The type of the object
"""
- events: typing.List[DataEvent] = pydantic.Field()
+ events: typing.Optional[typing.List[DataEvent]] = pydantic.Field(default=None)
"""
A list of data events
"""
diff --git a/src/intercom/types/data_event_summary.py b/src/intercom/types/data_event_summary.py
index e39975d..4dab92b 100644
--- a/src/intercom/types/data_event_summary.py
+++ b/src/intercom/types/data_event_summary.py
@@ -33,7 +33,7 @@ class DataEventSummary(UncheckedBaseModel):
The user ID of the user
"""
- events: typing.List[DataEventSummaryItem] = pydantic.Field()
+ events: typing.List[typing.Optional[DataEventSummaryItem]] = pydantic.Field()
"""
A summary of data events
"""
diff --git a/src/intercom/types/data_event_summary_item.py b/src/intercom/types/data_event_summary_item.py
index f540a43..aa3842f 100644
--- a/src/intercom/types/data_event_summary_item.py
+++ b/src/intercom/types/data_event_summary_item.py
@@ -12,22 +12,22 @@ class DataEventSummaryItem(UncheckedBaseModel):
This will return a summary of a data event for the App.
"""
- name: str = pydantic.Field()
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
The name of the event
"""
- first: str = pydantic.Field()
+ first: typing.Optional[str] = pydantic.Field(default=None)
"""
The first time the event was sent
"""
- last: str = pydantic.Field()
+ last: typing.Optional[str] = pydantic.Field(default=None)
"""
The last time the event was sent
"""
- count: int = pydantic.Field()
+ count: typing.Optional[int] = pydantic.Field(default=None)
"""
The number of times the event was sent
"""
diff --git a/src/intercom/types/data_export_csv.py b/src/intercom/types/data_export_csv.py
index 2f83871..40518e8 100644
--- a/src/intercom/types/data_export_csv.py
+++ b/src/intercom/types/data_export_csv.py
@@ -12,7 +12,7 @@ class DataExportCsv(UncheckedBaseModel):
A CSV output file
"""
- user_id: str = pydantic.Field()
+ user_id: typing.Optional[str] = pydantic.Field(default=None)
"""
The user_id of the user who was sent the message.
"""
@@ -22,37 +22,37 @@ class DataExportCsv(UncheckedBaseModel):
The external_user_id of the user who was sent the message
"""
- company_id: str = pydantic.Field()
+ company_id: typing.Optional[str] = pydantic.Field(default=None)
"""
The company ID of the user in relation to the message that was sent. Will return -1 if no company is present.
"""
- email: str = pydantic.Field()
+ email: typing.Optional[str] = pydantic.Field(default=None)
"""
The users email who was sent the message.
"""
- name: str = pydantic.Field()
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
The full name of the user receiving the message
"""
- ruleset_id: str = pydantic.Field()
+ ruleset_id: typing.Optional[str] = pydantic.Field(default=None)
"""
The id of the message.
"""
- content_id: str = pydantic.Field()
+ content_id: typing.Optional[str] = pydantic.Field(default=None)
"""
The specific content that was received. In an A/B test each version has its own Content ID.
"""
- content_type: str = pydantic.Field()
+ content_type: typing.Optional[str] = pydantic.Field(default=None)
"""
Email, Chat, Post etc.
"""
- content_title: str = pydantic.Field()
+ content_title: typing.Optional[str] = pydantic.Field(default=None)
"""
The title of the content you see in your Intercom workspace.
"""
diff --git a/src/intercom/types/datetime.py b/src/intercom/types/datetime.py
new file mode 100644
index 0000000..97bfdac
--- /dev/null
+++ b/src/intercom/types/datetime.py
@@ -0,0 +1,6 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+Datetime = typing.Union[dt.datetime, int]
diff --git a/src/intercom/types/deleted_article_object.py b/src/intercom/types/deleted_article_object.py
index 13bf420..40038e7 100644
--- a/src/intercom/types/deleted_article_object.py
+++ b/src/intercom/types/deleted_article_object.py
@@ -12,17 +12,17 @@ class DeletedArticleObject(UncheckedBaseModel):
Response returned when an object is deleted
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The unique identifier for the article which you provided in the URL.
"""
- object: typing.Literal["article"] = pydantic.Field(default="article")
+ object: typing.Optional[typing.Literal["article"]] = pydantic.Field(default=None)
"""
The type of object which was deleted. - article
"""
- deleted: bool = pydantic.Field()
+ deleted: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether the article was deleted successfully or not.
"""
diff --git a/src/intercom/types/deleted_collection_object.py b/src/intercom/types/deleted_collection_object.py
index 509a2fc..1628b9f 100644
--- a/src/intercom/types/deleted_collection_object.py
+++ b/src/intercom/types/deleted_collection_object.py
@@ -12,17 +12,17 @@ class DeletedCollectionObject(UncheckedBaseModel):
Response returned when an object is deleted
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The unique identifier for the collection which you provided in the URL.
"""
- object: typing.Literal["collection"] = pydantic.Field(default="collection")
+ object: typing.Optional[typing.Literal["collection"]] = pydantic.Field(default=None)
"""
The type of object which was deleted. - `collection`
"""
- deleted: bool = pydantic.Field()
+ deleted: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether the collection was deleted successfully or not.
"""
diff --git a/src/intercom/types/deleted_company_object.py b/src/intercom/types/deleted_company_object.py
index e173078..16ad8ef 100644
--- a/src/intercom/types/deleted_company_object.py
+++ b/src/intercom/types/deleted_company_object.py
@@ -12,17 +12,17 @@ class DeletedCompanyObject(UncheckedBaseModel):
Response returned when an object is deleted
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The unique identifier for the company which is given by Intercom.
"""
- object: typing.Literal["company"] = pydantic.Field(default="company")
+ object: typing.Optional[typing.Literal["company"]] = pydantic.Field(default=None)
"""
The type of object which was deleted. - `company`
"""
- deleted: bool = pydantic.Field()
+ deleted: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether the company was deleted successfully or not.
"""
diff --git a/src/intercom/types/deleted_internal_article_object.py b/src/intercom/types/deleted_internal_article_object.py
new file mode 100644
index 0000000..848b27e
--- /dev/null
+++ b/src/intercom/types/deleted_internal_article_object.py
@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class DeletedInternalArticleObject(UncheckedBaseModel):
+ """
+ Response returned when an object is deleted
+ """
+
+ id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The unique identifier for the internal article which you provided in the URL.
+ """
+
+ object: typing.Optional[typing.Literal["internal_article"]] = pydantic.Field(default=None)
+ """
+ The type of object which was deleted. - internal_article
+ """
+
+ deleted: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Whether the internal article was deleted successfully or not.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/deleted_object.py b/src/intercom/types/deleted_object.py
index c3ed7d6..dbf1f77 100644
--- a/src/intercom/types/deleted_object.py
+++ b/src/intercom/types/deleted_object.py
@@ -12,17 +12,17 @@ class DeletedObject(UncheckedBaseModel):
Response returned when an object is deleted
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The unique identifier for the news item which you provided in the URL.
"""
- object: typing.Literal["news-item"] = pydantic.Field(default="news-item")
+ object: typing.Optional[typing.Literal["news-item"]] = pydantic.Field(default=None)
"""
The type of object which was deleted - news-item.
"""
- deleted: bool = pydantic.Field()
+ deleted: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether the news item was deleted successfully or not.
"""
diff --git a/src/intercom/types/dropdown_component.py b/src/intercom/types/dropdown_component.py
deleted file mode 100644
index dd170e7..0000000
--- a/src/intercom/types/dropdown_component.py
+++ /dev/null
@@ -1,56 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-from .dropdown_component_save_state import DropdownComponentSaveState
-from .dropdown_option import DropdownOption
-
-
-class DropdownComponent(UncheckedBaseModel):
- """
- A dropdown component is used to capture a choice from the options that you provide.
-
- When submitted, the dropdown choices are returned in a hash with the id from the dropdown component used as the key and the id from the chosen option as the value.
- """
-
- id: str = pydantic.Field()
- """
- A unique identifier for the component.
- """
-
- options: typing.List[DropdownOption] = pydantic.Field()
- """
- The list of options. Can provide 2 to 10.
- """
-
- label: typing.Optional[str] = pydantic.Field(default=None)
- """
- The text shown above the dropdown.
- """
-
- value: typing.Optional[str] = pydantic.Field(default=None)
- """
- The option that is selected by default.
- """
-
- save_state: typing.Optional[DropdownComponentSaveState] = pydantic.Field(default=None)
- """
- Styles all options and prevents the action. Default is `unsaved`. Will be overridden if `save_state` is `saved`.
- """
-
- disabled: typing.Optional[bool] = pydantic.Field(default=None)
- """
- Styles all options and prevents the action. Default is false. Will be overridden if save_state is saved.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/dropdown_component_save_state.py b/src/intercom/types/dropdown_component_save_state.py
deleted file mode 100644
index acd8e89..0000000
--- a/src/intercom/types/dropdown_component_save_state.py
+++ /dev/null
@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-DropdownComponentSaveState = typing.Union[typing.Literal["unsaved", "saved", "failed"], typing.Any]
diff --git a/src/intercom/types/email_address_header.py b/src/intercom/types/email_address_header.py
new file mode 100644
index 0000000..9e990ad
--- /dev/null
+++ b/src/intercom/types/email_address_header.py
@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class EmailAddressHeader(UncheckedBaseModel):
+ """
+ Contains data for an email address header for a conversation part that was sent as an email.
+ """
+
+ type: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The type of email address header
+ """
+
+ email_address: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The email address
+ """
+
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The name associated with the email address
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/data_table_item.py b/src/intercom/types/email_message_metadata.py
similarity index 57%
rename from src/intercom/types/data_table_item.py
rename to src/intercom/types/email_message_metadata.py
index eb416f2..eb80c07 100644
--- a/src/intercom/types/data_table_item.py
+++ b/src/intercom/types/email_message_metadata.py
@@ -5,26 +5,22 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
+from .email_address_header import EmailAddressHeader
-class DataTableItem(UncheckedBaseModel):
+class EmailMessageMetadata(UncheckedBaseModel):
"""
- A field-value pair component for use in a data table.
+ Contains metadata if the message was sent as an email
"""
- type: typing.Literal["field-value"] = pydantic.Field(default="field-value")
+ subject: typing.Optional[str] = pydantic.Field(default=None)
"""
- The type of component you are rendering.
+ The subject of the email
"""
- field: str = pydantic.Field()
+ email_address_headers: typing.Optional[typing.List[EmailAddressHeader]] = pydantic.Field(default=None)
"""
- The text of the key in your key-value pair.
- """
-
- value: str = pydantic.Field()
- """
- The text of the value in your key-value pair.
+ A list of an email address headers.
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/event_details.py b/src/intercom/types/event_details.py
new file mode 100644
index 0000000..2bef222
--- /dev/null
+++ b/src/intercom/types/event_details.py
@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .conversation_attribute_updated_by_admin import ConversationAttributeUpdatedByAdmin
+from .conversation_attribute_updated_by_workflow import ConversationAttributeUpdatedByWorkflow
+from .custom_action_finished import CustomActionFinished
+from .custom_action_started import CustomActionStarted
+from .operator_workflow_event import OperatorWorkflowEvent
+
+EventDetails = typing.Union[
+ ConversationAttributeUpdatedByWorkflow,
+ ConversationAttributeUpdatedByAdmin,
+ CustomActionStarted,
+ CustomActionFinished,
+ OperatorWorkflowEvent,
+]
diff --git a/src/intercom/types/file_attribute.py b/src/intercom/types/file_attribute.py
index 8ba2af0..e63f4cc 100644
--- a/src/intercom/types/file_attribute.py
+++ b/src/intercom/types/file_attribute.py
@@ -12,33 +12,33 @@ class FileAttribute(UncheckedBaseModel):
The value describing a file upload set for a custom attribute
"""
- type: str
- name: str = pydantic.Field()
+ type: typing.Optional[str] = None
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
The name of the file
"""
- url: str = pydantic.Field()
+ url: typing.Optional[str] = pydantic.Field(default=None)
"""
The url of the file. This is a temporary URL and will expire after 30 minutes.
"""
- content_type: str = pydantic.Field()
+ content_type: typing.Optional[str] = pydantic.Field(default=None)
"""
The type of file
"""
- filesize: int = pydantic.Field()
+ filesize: typing.Optional[int] = pydantic.Field(default=None)
"""
The size of the file in bytes
"""
- width: int = pydantic.Field()
+ width: typing.Optional[int] = pydantic.Field(default=None)
"""
The width of the file in pixels, if applicable
"""
- height: int = pydantic.Field()
+ height: typing.Optional[int] = pydantic.Field(default=None)
"""
The height of the file in pixels, if applicable
"""
diff --git a/src/intercom/types/group_content.py b/src/intercom/types/group_content.py
index d06dca4..36d3266 100644
--- a/src/intercom/types/group_content.py
+++ b/src/intercom/types/group_content.py
@@ -12,17 +12,17 @@ class GroupContent(UncheckedBaseModel):
The Content of a Group.
"""
- type: typing.Literal["group_content"] = pydantic.Field(default="group_content")
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
The type of object - `group_content` .
"""
- name: str = pydantic.Field()
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
The name of the collection or section.
"""
- description: str = pydantic.Field()
+ description: typing.Optional[str] = pydantic.Field(default=None)
"""
The description of the collection. Only available for collections.
"""
diff --git a/src/intercom/types/group_translated_content.py b/src/intercom/types/group_translated_content.py
index 7bc6b60..2a73782 100644
--- a/src/intercom/types/group_translated_content.py
+++ b/src/intercom/types/group_translated_content.py
@@ -15,7 +15,7 @@ class GroupTranslatedContent(UncheckedBaseModel):
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
"""
- type: typing.Literal["group_translated_content"] = pydantic.Field(default="group_translated_content")
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
The type of object - group_translated_content.
"""
diff --git a/src/intercom/types/image_component.py b/src/intercom/types/image_component.py
deleted file mode 100644
index 74b796c..0000000
--- a/src/intercom/types/image_component.py
+++ /dev/null
@@ -1,67 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-from .image_component_align import ImageComponentAlign
-from .url_action_component import UrlActionComponent
-
-
-class ImageComponent(UncheckedBaseModel):
- """
- An image component is used to display an image.
-
- HTTPS Images:
- If your request URLs (or website URLs) are over HTTPS, you will need to ensure that images are loaded over HTTPS likewise. Otherwise, they will not work.
- """
-
- id: typing.Optional[str] = pydantic.Field(default=None)
- """
- A unique identifier for the component.
- """
-
- url: str = pydantic.Field()
- """
- The URL where the image is located.
- """
-
- align: typing.Optional[ImageComponentAlign] = pydantic.Field(default=None)
- """
- Aligns the image inside the component. Default is `left`.
- """
-
- width: int = pydantic.Field()
- """
- The exact width of the image in pixels.
- """
-
- height: int = pydantic.Field()
- """
- The exact height of the image in pixels.
- """
-
- rounded: typing.Optional[bool] = pydantic.Field(default=None)
- """
- Rounds the corners of the image. Default is `false`.
- """
-
- bottom_margin: typing.Optional[typing.Literal["none"]] = pydantic.Field(default=None)
- """
- Disables a component's margin-bottom of 10px.
- """
-
- action: typing.Optional[UrlActionComponent] = pydantic.Field(default=None)
- """
- This can be a URL Action only.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/image_component_align.py b/src/intercom/types/image_component_align.py
deleted file mode 100644
index 2464853..0000000
--- a/src/intercom/types/image_component_align.py
+++ /dev/null
@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-ImageComponentAlign = typing.Union[typing.Literal["left", "center", "right", "full_width"], typing.Any]
diff --git a/src/intercom/types/initialize_request.py b/src/intercom/types/initialize_request.py
deleted file mode 100644
index ac06b2d..0000000
--- a/src/intercom/types/initialize_request.py
+++ /dev/null
@@ -1,61 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..admins.types.admin import Admin
-from ..contacts.types.contact import Contact
-from ..conversations.types.conversation import Conversation
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-from .context import Context
-
-
-class InitializeRequest(UncheckedBaseModel):
- """
- The request payload will have all the data needed for you to understand who is using your app, where they are using it, and how you should respond. There are different request payloads for Messenger capabilities and Inbox capabilities.
- """
-
- workspace_id: str = pydantic.Field()
- """
- The workspace ID of the teammate. Attribute is `app_id` for V1.2 and below.
- """
-
- workspace_region: str = pydantic.Field()
- """
- The Intercom hosted region that this app is located in.
- """
-
- admin: Admin = pydantic.Field()
- """
- The Intercom teammate viewing the conversation.
- """
-
- card_creation_options: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
- """
- Key-value pairs which were given as results in response to the Configure request.
- """
-
- context: Context = pydantic.Field()
- """
- The context of where the app is added, where the user last visited, and information on the Messenger settings.
- """
-
- conversation: Conversation = pydantic.Field()
- """
- The conversation your app is being shown for.
- """
-
- contact: Contact = pydantic.Field()
- """
- The contact which is currently being viewed by the teammate in the conversation details panel. We send an individual initialize request for each customer when it's a group conversation.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/input_component.py b/src/intercom/types/input_component.py
deleted file mode 100644
index d9e3eed..0000000
--- a/src/intercom/types/input_component.py
+++ /dev/null
@@ -1,62 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-from .action_component import ActionComponent
-from .input_component_save_state import InputComponentSaveState
-
-
-class InputComponent(UncheckedBaseModel):
- """
- An input component is used to capture text input from the end user. You can submit the value of the input by:
-
- - Adding an `action` to the input component (which will render an inline button)
- - Using a ButtonComponent (which will submit all interactive components in the canvas)
- """
-
- id: str = pydantic.Field()
- """
- A unique identifier for the component.
- """
-
- label: typing.Optional[str] = pydantic.Field(default=None)
- """
- The text shown above the input.
- """
-
- placeholder: typing.Optional[str] = pydantic.Field(default=None)
- """
- An example value shown inside the component when it's empty.
- """
-
- value: typing.Optional[str] = pydantic.Field(default=None)
- """
- An entered value which is already inside the component.
- """
-
- action: typing.Optional[ActionComponent] = pydantic.Field(default=None)
- """
- This can be a Submit Action, URL Action, or Sheets Action.
- """
-
- save_state: typing.Optional[InputComponentSaveState] = pydantic.Field(default=None)
- """
- Styles the input. Default is `unsaved`. Prevent action with `saved`.
- """
-
- disabled: typing.Optional[bool] = pydantic.Field(default=None)
- """
- Styles the input and prevents the action. Default is false. Will be overridden if save_state is saved.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/input_component_save_state.py b/src/intercom/types/input_component_save_state.py
deleted file mode 100644
index eee1e9a..0000000
--- a/src/intercom/types/input_component_save_state.py
+++ /dev/null
@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-InputComponentSaveState = typing.Union[typing.Literal["unsaved", "saved", "failed"], typing.Any]
diff --git a/src/intercom/types/internal_article_list.py b/src/intercom/types/internal_article_list.py
new file mode 100644
index 0000000..760b1ea
--- /dev/null
+++ b/src/intercom/types/internal_article_list.py
@@ -0,0 +1,40 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from ..internal_articles.types.internal_article_list_item import InternalArticleListItem
+from .cursor_pages import CursorPages
+
+
+class InternalArticleList(UncheckedBaseModel):
+ """
+ This will return a list of internal articles for the App.
+ """
+
+ type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None)
+ """
+ The type of the object - `list`.
+ """
+
+ pages: typing.Optional[CursorPages] = None
+ total_count: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ A count of the total number of internal articles.
+ """
+
+ data: typing.Optional[typing.List[InternalArticleListItem]] = pydantic.Field(default=None)
+ """
+ An array of Internal Article objects
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/linked_object.py b/src/intercom/types/linked_object.py
index bc8f836..f8d6f3b 100644
--- a/src/intercom/types/linked_object.py
+++ b/src/intercom/types/linked_object.py
@@ -13,12 +13,12 @@ class LinkedObject(UncheckedBaseModel):
A linked conversation or ticket.
"""
- type: LinkedObjectType = pydantic.Field()
+ type: typing.Optional[LinkedObjectType] = pydantic.Field(default=None)
"""
ticket or conversation
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The ID of the linked object
"""
diff --git a/src/intercom/types/linked_object_list.py b/src/intercom/types/linked_object_list.py
index 660b7ec..d3221de 100644
--- a/src/intercom/types/linked_object_list.py
+++ b/src/intercom/types/linked_object_list.py
@@ -13,22 +13,22 @@ class LinkedObjectList(UncheckedBaseModel):
An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.
"""
- type: typing.Literal["list"] = pydantic.Field(default="list")
+ type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None)
"""
Always list.
"""
- total_count: int = pydantic.Field()
+ total_count: typing.Optional[int] = pydantic.Field(default=None)
"""
The total number of linked objects.
"""
- has_more: bool = pydantic.Field()
+ has_more: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether or not there are more linked objects than returned.
"""
- data: typing.List[LinkedObject] = pydantic.Field()
+ data: typing.Optional[typing.List[LinkedObject]] = pydantic.Field(default=None)
"""
An array containing the linked conversations and linked tickets.
"""
diff --git a/src/intercom/types/list_component.py b/src/intercom/types/list_component.py
deleted file mode 100644
index 69f3393..0000000
--- a/src/intercom/types/list_component.py
+++ /dev/null
@@ -1,37 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-from .list_component_items_item import ListComponentItemsItem
-
-
-class ListComponent(UncheckedBaseModel):
- """
- A list component renders a list of items which you provide in an array. You can make each list item take an action by adding the relevant action object to the item:
-
- - [Trigger a submit request to be sent](https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/submit-action) Inbox Messenger
- - [Open a link in a new page](https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/url-action) Inbox Messenger
- - [Open a sheet](https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/sheets-action) Messenger
- """
-
- items: typing.List[ListComponentItemsItem] = pydantic.Field()
- """
- The items that will be rendered in the list.
- """
-
- disabled: typing.Optional[bool] = pydantic.Field(default=None)
- """
- Styles all list items and prevents the action. Default is `false`.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/list_component_items_item.py b/src/intercom/types/list_component_items_item.py
deleted file mode 100644
index 8549e33..0000000
--- a/src/intercom/types/list_component_items_item.py
+++ /dev/null
@@ -1,8 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-from .list_item_with_image import ListItemWithImage
-from .list_item_without_image import ListItemWithoutImage
-
-ListComponentItemsItem = typing.Union[ListItemWithImage, ListItemWithoutImage]
diff --git a/src/intercom/types/list_item.py b/src/intercom/types/list_item.py
deleted file mode 100644
index f2263d3..0000000
--- a/src/intercom/types/list_item.py
+++ /dev/null
@@ -1,63 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-from .action_component import ActionComponent
-
-
-class ListItem(UncheckedBaseModel):
- """
- A list item component that can be rendered in a list.
- """
-
- type: typing.Literal["item"] = pydantic.Field(default="item")
- """
- The type of component you are rendering.
- """
-
- id: str = pydantic.Field()
- """
- A unique identifier for the item.
- """
-
- title: str = pydantic.Field()
- """
- The text shown as the title for the item.
- """
-
- subtitle: typing.Optional[str] = pydantic.Field(default=None)
- """
- The text shown underneath the item's title.
- """
-
- tertiary_text: typing.Optional[str] = pydantic.Field(default=None)
- """
- The text shown next to the subtitle, separates by a bullet.
- """
-
- rounded_image: typing.Optional[bool] = pydantic.Field(default=None)
- """
- Rounds the corners of the image. Default is `false`.
- """
-
- disabled: typing.Optional[bool] = pydantic.Field(default=None)
- """
- Styles all list items and prevents the action. Default is `false`.
- """
-
- action: typing.Optional[ActionComponent] = pydantic.Field(default=None)
- """
- This can be a Submit Action, URL Action, or Sheets Action.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/list_item_without_image.py b/src/intercom/types/list_item_without_image.py
deleted file mode 100644
index ee43156..0000000
--- a/src/intercom/types/list_item_without_image.py
+++ /dev/null
@@ -1,33 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from .list_item import ListItem
-
-
-class ListItemWithoutImage(ListItem):
- image: typing.Optional[str] = pydantic.Field(default=None)
- """
- An image that will be displayed to the left of the item.
- """
-
- image_width: typing.Optional[int] = pydantic.Field(default=None)
- """
- The exact width of the image in pixels.
- """
-
- image_height: typing.Optional[int] = pydantic.Field(default=None)
- """
- The exact height of the image in pixels.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/live_canvas_request.py b/src/intercom/types/live_canvas_request.py
deleted file mode 100644
index 998c617..0000000
--- a/src/intercom/types/live_canvas_request.py
+++ /dev/null
@@ -1,52 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..contacts.types.contact import Contact
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-from .canvas_object import CanvasObject
-from .context import Context
-
-
-class LiveCanvasRequest(UncheckedBaseModel):
- """
- Canvases are static by default and require a new request to come through in order to update them. Live canvases however will make requests every time the card is viewed without any interaction needed, meaning the canvas can be kept up-to-date with no action from the user.
-
- This works for every Messenger request that you can respond with a canvas object to. Instead of returning the content object within the canvas object, you should provide a `content_url` attribute instead with the value being the URL you want us to send a POST request to when someone views the app.
- """
-
- workspace_id: str = pydantic.Field()
- """
- The workspace ID of the teammate. Attribute is `app_id` for V1.2 and below.
- """
-
- workspace_region: str = pydantic.Field()
- """
- The Intercom hosted region that this app is located in.
- """
-
- canvas: CanvasObject = pydantic.Field()
- """
- The current_canvas the teammate can see.
- """
-
- context: Context = pydantic.Field()
- """
- The context of where the app is added, where the user last visited, and information on the Messenger settings.
- """
-
- contact: Contact = pydantic.Field()
- """
- The contact who viewed the card.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/multiple_filter_search_request.py b/src/intercom/types/multiple_filter_search_request.py
index 9ed97b0..e0bc1c3 100644
--- a/src/intercom/types/multiple_filter_search_request.py
+++ b/src/intercom/types/multiple_filter_search_request.py
@@ -20,7 +20,7 @@ class MultipleFilterSearchRequest(UncheckedBaseModel):
An operator to allow boolean inspection between multiple fields.
"""
- value: typing.Optional[typing.List["MultipleOrSingleFilterSearchRequest"]] = None
+ value: typing.Optional["MultipleFilterSearchRequestValue"] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -32,6 +32,6 @@ class Config:
extra = pydantic.Extra.allow
-from .multiple_or_single_filter_search_request import MultipleOrSingleFilterSearchRequest # noqa: E402, F401, I001
+from .multiple_filter_search_request_value import MultipleFilterSearchRequestValue # noqa: E402, F401, I001
update_forward_refs(MultipleFilterSearchRequest)
diff --git a/src/intercom/types/multiple_or_single_filter_search_request.py b/src/intercom/types/multiple_filter_search_request_value.py
similarity index 67%
rename from src/intercom/types/multiple_or_single_filter_search_request.py
rename to src/intercom/types/multiple_filter_search_request_value.py
index 1d6d20f..16a7c59 100644
--- a/src/intercom/types/multiple_or_single_filter_search_request.py
+++ b/src/intercom/types/multiple_filter_search_request_value.py
@@ -8,4 +8,6 @@
if typing.TYPE_CHECKING:
from .multiple_filter_search_request import MultipleFilterSearchRequest
-MultipleOrSingleFilterSearchRequest = typing.Union["MultipleFilterSearchRequest", SingleFilterSearchRequest]
+MultipleFilterSearchRequestValue = typing.Union[
+ typing.List["MultipleFilterSearchRequest"], typing.List[SingleFilterSearchRequest]
+]
diff --git a/src/intercom/types/not_found_error_body.py b/src/intercom/types/not_found_error_body.py
new file mode 100644
index 0000000..b19fe72
--- /dev/null
+++ b/src/intercom/types/not_found_error_body.py
@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .not_found_error_body_errors_item import NotFoundErrorBodyErrorsItem
+
+
+class NotFoundErrorBody(UncheckedBaseModel):
+ type: str = pydantic.Field()
+ """
+ The type is error.list
+ """
+
+ request_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+
+ """
+
+ errors: typing.List[NotFoundErrorBodyErrorsItem] = pydantic.Field()
+ """
+ An array of one or more error objects
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/not_found_error_body_errors_item.py b/src/intercom/types/not_found_error_body_errors_item.py
new file mode 100644
index 0000000..ca80ecf
--- /dev/null
+++ b/src/intercom/types/not_found_error_body_errors_item.py
@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class NotFoundErrorBodyErrorsItem(UncheckedBaseModel):
+ code: str = pydantic.Field()
+ """
+ ticket_not_found
+ """
+
+ message: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Ticket not found
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/note_list.py b/src/intercom/types/note_list.py
index b095fe0..7ba90ce 100644
--- a/src/intercom/types/note_list.py
+++ b/src/intercom/types/note_list.py
@@ -13,17 +13,17 @@ class NoteList(UncheckedBaseModel):
A paginated list of notes associated with a contact.
"""
- type: typing.Literal["list"] = pydantic.Field(default="list")
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
String representing the object's type. Always has the value `list`.
"""
- data: typing.List[Note] = pydantic.Field()
+ data: typing.Optional[typing.List[Note]] = pydantic.Field(default=None)
"""
An array of notes.
"""
- total_count: int = pydantic.Field()
+ total_count: typing.Optional[int] = pydantic.Field(default=None)
"""
A count of the total number of notes.
"""
diff --git a/src/intercom/types/operator_workflow_event.py b/src/intercom/types/operator_workflow_event.py
new file mode 100644
index 0000000..d9ec497
--- /dev/null
+++ b/src/intercom/types/operator_workflow_event.py
@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .operator_workflow_event_event import OperatorWorkflowEventEvent
+from .operator_workflow_event_workflow import OperatorWorkflowEventWorkflow
+
+
+class OperatorWorkflowEvent(UncheckedBaseModel):
+ """
+ Contains details about name of the workflow for conversation part type operator_workflow_event.
+ """
+
+ workflow: typing.Optional[OperatorWorkflowEventWorkflow] = None
+ event: typing.Optional[OperatorWorkflowEventEvent] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/operator_workflow_event_event.py b/src/intercom/types/operator_workflow_event_event.py
new file mode 100644
index 0000000..10bf3ef
--- /dev/null
+++ b/src/intercom/types/operator_workflow_event_event.py
@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class OperatorWorkflowEventEvent(UncheckedBaseModel):
+ type: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Type of the workflow event initiated
+ """
+
+ result: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Result of the workflow event
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/operator_workflow_event_workflow.py b/src/intercom/types/operator_workflow_event_workflow.py
new file mode 100644
index 0000000..0952658
--- /dev/null
+++ b/src/intercom/types/operator_workflow_event_workflow.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class OperatorWorkflowEventWorkflow(UncheckedBaseModel):
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The name of the workflow
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/pages_link.py b/src/intercom/types/pages_link.py
index f041d00..ccd818f 100644
--- a/src/intercom/types/pages_link.py
+++ b/src/intercom/types/pages_link.py
@@ -14,15 +14,15 @@ class PagesLink(UncheckedBaseModel):
Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.
"""
- type: typing.Literal["pages"] = "pages"
- page: int
+ type: typing.Optional[typing.Literal["pages"]] = None
+ page: typing.Optional[int] = None
next: typing.Optional[str] = pydantic.Field(default=None)
"""
A link to the next page of results. A response that does not contain a next link does not have further data to fetch.
"""
- per_page: int
- total_pages: int
+ per_page: typing.Optional[int] = None
+ total_pages: typing.Optional[int] = None
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/intercom/types/paginated_newsfeed_response.py b/src/intercom/types/paginated_response.py
similarity index 57%
rename from src/intercom/types/paginated_newsfeed_response.py
rename to src/intercom/types/paginated_response.py
index 4da53c3..787bff8 100644
--- a/src/intercom/types/paginated_newsfeed_response.py
+++ b/src/intercom/types/paginated_response.py
@@ -5,29 +5,30 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
-from ..news.types.newsfeed import Newsfeed
from .cursor_pages import CursorPages
+from .paginated_response_data_item import PaginatedResponseDataItem
+from .paginated_response_type import PaginatedResponseType
-class PaginatedNewsfeedResponse(UncheckedBaseModel):
+class PaginatedResponse(UncheckedBaseModel):
"""
- Paginated Newsfeed Response
+ Paginated Response
"""
- type: typing.Literal["list"] = pydantic.Field(default="list")
+ type: typing.Optional[PaginatedResponseType] = pydantic.Field(default=None)
"""
The type of object
"""
pages: typing.Optional[CursorPages] = None
- total_count: int = pydantic.Field()
+ total_count: typing.Optional[int] = pydantic.Field(default=None)
"""
- A count of the total number of Newsfeeds.
+ A count of the total number of objects.
"""
- data: typing.List[Newsfeed] = pydantic.Field()
+ data: typing.Optional[typing.List[PaginatedResponseDataItem]] = pydantic.Field(default=None)
"""
- An array of Newsfeeds
+ An array of Objects
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/paginated_response_data_item.py b/src/intercom/types/paginated_response_data_item.py
new file mode 100644
index 0000000..0052b2f
--- /dev/null
+++ b/src/intercom/types/paginated_response_data_item.py
@@ -0,0 +1,61 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel, UnionMetadata
+from ..news.types.news_item_state import NewsItemState
+from ..news.types.newsfeed_assignment import NewsfeedAssignment
+
+
+class PaginatedResponseDataItem_NewsItem(UncheckedBaseModel):
+ type: typing.Literal["news-item"] = "news-item"
+ id: typing.Optional[str] = None
+ workspace_id: typing.Optional[str] = None
+ title: typing.Optional[str] = None
+ body: typing.Optional[str] = None
+ sender_id: typing.Optional[int] = None
+ state: typing.Optional[NewsItemState] = None
+ newsfeed_assignments: typing.Optional[typing.List[NewsfeedAssignment]] = None
+ labels: typing.Optional[typing.List[typing.Optional[str]]] = None
+ cover_image_url: typing.Optional[str] = None
+ reactions: typing.Optional[typing.List[typing.Optional[str]]] = None
+ deliver_silently: typing.Optional[bool] = None
+ created_at: typing.Optional[int] = None
+ updated_at: typing.Optional[int] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+class PaginatedResponseDataItem_Newsfeed(UncheckedBaseModel):
+ type: typing.Literal["newsfeed"] = "newsfeed"
+ id: typing.Optional[str] = None
+ name: typing.Optional[str] = None
+ created_at: typing.Optional[int] = None
+ updated_at: typing.Optional[int] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
+
+
+PaginatedResponseDataItem = typing_extensions.Annotated[
+ typing.Union[PaginatedResponseDataItem_NewsItem, PaginatedResponseDataItem_Newsfeed],
+ UnionMetadata(discriminant="type"),
+]
diff --git a/src/intercom/types/paginated_response_type.py b/src/intercom/types/paginated_response_type.py
new file mode 100644
index 0000000..04cce50
--- /dev/null
+++ b/src/intercom/types/paginated_response_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PaginatedResponseType = typing.Union[typing.Literal["list", "conversation.list"], typing.Any]
diff --git a/src/intercom/types/part_attachment.py b/src/intercom/types/part_attachment.py
index 0c4495f..7917095 100644
--- a/src/intercom/types/part_attachment.py
+++ b/src/intercom/types/part_attachment.py
@@ -12,37 +12,37 @@ class PartAttachment(UncheckedBaseModel):
The file attached to a part
"""
- type: str = pydantic.Field()
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
The type of attachment
"""
- name: str = pydantic.Field()
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
The name of the attachment
"""
- url: str = pydantic.Field()
+ url: typing.Optional[str] = pydantic.Field(default=None)
"""
The URL of the attachment
"""
- content_type: str = pydantic.Field()
+ content_type: typing.Optional[str] = pydantic.Field(default=None)
"""
The content type of the attachment
"""
- filesize: int = pydantic.Field()
+ filesize: typing.Optional[int] = pydantic.Field(default=None)
"""
The size of the attachment
"""
- width: int = pydantic.Field()
+ width: typing.Optional[int] = pydantic.Field(default=None)
"""
The width of the attachment
"""
- height: int = pydantic.Field()
+ height: typing.Optional[int] = pydantic.Field(default=None)
"""
The height of the attachment
"""
diff --git a/src/intercom/types/phone_switch.py b/src/intercom/types/phone_switch.py
index a8cfb40..7f20b7a 100644
--- a/src/intercom/types/phone_switch.py
+++ b/src/intercom/types/phone_switch.py
@@ -12,12 +12,12 @@ class PhoneSwitch(UncheckedBaseModel):
Phone Switch Response
"""
- type: typing.Literal["phone_call_redirect"] = pydantic.Field(default="phone_call_redirect")
+ type: typing.Optional[typing.Literal["phone_call_redirect"]] = pydantic.Field(default=None)
"""
"""
- phone: str = pydantic.Field()
+ phone: typing.Optional[str] = pydantic.Field(default=None)
"""
Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.
"""
diff --git a/src/intercom/types/checkbox_option.py b/src/intercom/types/quick_reply_option.py
similarity index 52%
rename from src/intercom/types/checkbox_option.py
rename to src/intercom/types/quick_reply_option.py
index edc6c9b..15a918d 100644
--- a/src/intercom/types/checkbox_option.py
+++ b/src/intercom/types/quick_reply_option.py
@@ -3,33 +3,21 @@
import typing
import pydantic
+import typing_extensions
from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
from ..core.unchecked_base_model import UncheckedBaseModel
-class CheckboxOption(UncheckedBaseModel):
- """
- A checkbox option component that can be selected.
- """
-
- type: typing.Literal["option"] = pydantic.Field(default="option")
- """
- The type of component you are rendering.
- """
-
- id: str = pydantic.Field()
- """
- A unique identifier for the option.
- """
-
+class QuickReplyOption(UncheckedBaseModel):
text: str = pydantic.Field()
"""
- The text shown next to the checkbox.
+ The text to display in this quick reply option.
"""
- disabled: typing.Optional[bool] = pydantic.Field(default=None)
+ uuid_: typing_extensions.Annotated[str, FieldMetadata(alias="uuid")] = pydantic.Field()
"""
- Styles the option and prevents the action. Default is false.
+ A unique identifier for this quick reply option. This value will be available within the metadata of the comment conversation part that is created when a user clicks on this reply option.
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/contact_company.py b/src/intercom/types/recipient.py
similarity index 64%
rename from src/intercom/types/contact_company.py
rename to src/intercom/types/recipient.py
index bd60d28..e68adf0 100644
--- a/src/intercom/types/contact_company.py
+++ b/src/intercom/types/recipient.py
@@ -5,26 +5,22 @@
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
+from .recipient_type import RecipientType
-class ContactCompany(UncheckedBaseModel):
+class Recipient(UncheckedBaseModel):
"""
- A reference to a company associated with a contact
+ A recipient of a message
"""
- id: str = pydantic.Field()
+ type: RecipientType = pydantic.Field()
"""
- The unique identifier for the company
+ The role associated to the contact - `user` or `lead`.
"""
- type: typing.Literal["company"] = pydantic.Field(default="company")
- """
- The type of the object
- """
-
- url: str = pydantic.Field()
+ id: str = pydantic.Field()
"""
- URL to get the full company resource
+ The identifier for the contact which is given by Intercom.
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/recipient_type.py b/src/intercom/types/recipient_type.py
new file mode 100644
index 0000000..f423fd0
--- /dev/null
+++ b/src/intercom/types/recipient_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+RecipientType = typing.Union[typing.Literal["user", "lead"], typing.Any]
diff --git a/src/intercom/types/reference.py b/src/intercom/types/reference.py
index 2905e15..0c8ad77 100644
--- a/src/intercom/types/reference.py
+++ b/src/intercom/types/reference.py
@@ -12,7 +12,7 @@ class Reference(UncheckedBaseModel):
reference to another object
"""
- type: str = pydantic.Field()
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
"""
diff --git a/src/intercom/types/results_response.py b/src/intercom/types/results_response.py
deleted file mode 100644
index f6631fc..0000000
--- a/src/intercom/types/results_response.py
+++ /dev/null
@@ -1,27 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-
-
-class ResultsResponse(UncheckedBaseModel):
- """
- The results object should be sent when you want to end configuration of the app and trigger the [Initialize request](https://developers.intercom.com/docs/canvas-kit/#initialize) to be sent. You provide the key-value pairs of data you want access to and we will send these in the Initialize request within a [card_creation_options object](https://developers.intercom.com/docs/references/canvas-kit/requestobjects/card-creation-options/#card-creation-options).
- """
-
- results: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
- """
- Key-value pairs of data you want access to in the Initialize request
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/segment_list.py b/src/intercom/types/segment_list.py
index 4f1c48a..1c88624 100644
--- a/src/intercom/types/segment_list.py
+++ b/src/intercom/types/segment_list.py
@@ -13,12 +13,12 @@ class SegmentList(UncheckedBaseModel):
This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.
"""
- type: typing.Literal["segment.list"] = pydantic.Field(default="segment.list")
+ type: typing.Optional[typing.Literal["segment.list"]] = pydantic.Field(default=None)
"""
The type of the object
"""
- segments: typing.List[Segment] = pydantic.Field()
+ segments: typing.Optional[typing.List[Segment]] = pydantic.Field(default=None)
"""
A list of Segment objects
"""
diff --git a/src/intercom/types/single_filter_search_request_value.py b/src/intercom/types/single_filter_search_request_value.py
index 8bfa5aa..fcabc57 100644
--- a/src/intercom/types/single_filter_search_request_value.py
+++ b/src/intercom/types/single_filter_search_request_value.py
@@ -2,4 +2,6 @@
import typing
-SingleFilterSearchRequestValue = typing.Union[str, int, typing.List[str], typing.List[int]]
+from .single_filter_search_request_value_item import SingleFilterSearchRequestValueItem
+
+SingleFilterSearchRequestValue = typing.Union[str, int, typing.List[SingleFilterSearchRequestValueItem]]
diff --git a/src/intercom/types/single_filter_search_request_value_item.py b/src/intercom/types/single_filter_search_request_value_item.py
new file mode 100644
index 0000000..b921bab
--- /dev/null
+++ b/src/intercom/types/single_filter_search_request_value_item.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+SingleFilterSearchRequestValueItem = typing.Union[str, int]
diff --git a/src/intercom/types/single_select_component.py b/src/intercom/types/single_select_component.py
deleted file mode 100644
index ad33ef0..0000000
--- a/src/intercom/types/single_select_component.py
+++ /dev/null
@@ -1,65 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-from .action_component import ActionComponent
-from .single_select_component_save_state import SingleSelectComponentSaveState
-from .single_select_option import SingleSelectOption
-
-
-class SingleSelectComponent(UncheckedBaseModel):
- """
- A single-select component is used to capture a choice from up to 10 options that you provide. You can submit the value of the select option by:
-
- - Adding an `action` to the single-select component
- - Using a ButtonComponent (which will submit all interactive components in the canvas)
-
- When a submit action takes place, the results are given in a hash with the `id` from the single-select component used as the key and the `id` from the chosen option as the value.
- """
-
- id: str = pydantic.Field()
- """
- A unique identifier for the component.
- """
-
- options: typing.List[SingleSelectOption] = pydantic.Field()
- """
- The list of options. Can provide 2 to 10.
- """
-
- label: typing.Optional[str] = pydantic.Field(default=None)
- """
- The text shown above the options.
- """
-
- value: typing.Optional[str] = pydantic.Field(default=None)
- """
- The option that is selected by default.
- """
-
- save_state: typing.Optional[SingleSelectComponentSaveState] = pydantic.Field(default=None)
- """
- Styles the input. Default is `unsaved`. Prevent action with `saved`.
- """
-
- disabled: typing.Optional[bool] = pydantic.Field(default=None)
- """
- Styles all options and prevents the action. Default is false. Will be overridden if save_state is saved.
- """
-
- action: typing.Optional[ActionComponent] = pydantic.Field(default=None)
- """
- This can be a Submit Action, URL Action, or Sheets Action.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/single_select_component_save_state.py b/src/intercom/types/single_select_component_save_state.py
deleted file mode 100644
index dc85ce8..0000000
--- a/src/intercom/types/single_select_component_save_state.py
+++ /dev/null
@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-SingleSelectComponentSaveState = typing.Union[typing.Literal["unsaved", "saved", "failed"], typing.Any]
diff --git a/src/intercom/types/sla_applied.py b/src/intercom/types/sla_applied.py
index 187d1e7..b4b9073 100644
--- a/src/intercom/types/sla_applied.py
+++ b/src/intercom/types/sla_applied.py
@@ -14,17 +14,17 @@ class SlaApplied(UncheckedBaseModel):
Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.
"""
- type: str = pydantic.Field()
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
object type
"""
- sla_name: str = pydantic.Field()
+ sla_name: typing.Optional[str] = pydantic.Field(default=None)
"""
The name of the SLA as given by the teammate when it was created.
"""
- sla_status: SlaAppliedSlaStatus = pydantic.Field()
+ sla_status: typing.Optional[SlaAppliedSlaStatus] = pydantic.Field(default=None)
"""
SLA statuses:
- `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.
diff --git a/src/intercom/types/social_profile.py b/src/intercom/types/social_profile.py
index 3838408..f1b91d2 100644
--- a/src/intercom/types/social_profile.py
+++ b/src/intercom/types/social_profile.py
@@ -12,17 +12,17 @@ class SocialProfile(UncheckedBaseModel):
A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.
"""
- type: typing.Literal["social_profile"] = pydantic.Field(default="social_profile")
+ type: typing.Optional[typing.Literal["social_profile"]] = pydantic.Field(default=None)
"""
value is "social_profile"
"""
- name: str = pydantic.Field()
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
The name of the Social media profile
"""
- url: str = pydantic.Field()
+ url: typing.Optional[str] = pydantic.Field(default=None)
"""
The name of the Social media profile
"""
diff --git a/src/intercom/types/spacer_component_size.py b/src/intercom/types/spacer_component_size.py
deleted file mode 100644
index 3d4f5d3..0000000
--- a/src/intercom/types/spacer_component_size.py
+++ /dev/null
@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-SpacerComponentSize = typing.Union[typing.Literal["xs", "s", "m", "l", "xl"], typing.Any]
diff --git a/src/intercom/types/starting_after_paging.py b/src/intercom/types/starting_after_paging.py
index 7e5e9cc..e2c1a29 100644
--- a/src/intercom/types/starting_after_paging.py
+++ b/src/intercom/types/starting_after_paging.py
@@ -8,7 +8,7 @@
class StartingAfterPaging(UncheckedBaseModel):
- per_page: int = pydantic.Field()
+ per_page: typing.Optional[int] = pydantic.Field(default=None)
"""
The number of results to fetch per page.
"""
diff --git a/src/intercom/types/submit_request.py b/src/intercom/types/submit_request.py
deleted file mode 100644
index 2022592..0000000
--- a/src/intercom/types/submit_request.py
+++ /dev/null
@@ -1,77 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..admins.types.admin import Admin
-from ..contacts.types.contact import Contact
-from ..conversations.types.conversation import Conversation
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-from .context import Context
-from .current_canvas import CurrentCanvas
-
-
-class SubmitRequest(UncheckedBaseModel):
- """
- The Submit request is triggered when a component with a submit action is interacted with in Messenger Inbox.
- """
-
- workspace_id: str = pydantic.Field()
- """
- The workspace ID of the teammate. Attribute is `app_id` for V1.2 and below.
- """
-
- workspace_region: str = pydantic.Field()
- """
- The Intercom hosted region that this app is located in.
- """
-
- admin: Admin = pydantic.Field()
- """
- The Intercom teammate viewing the conversation.
- """
-
- component_id: str = pydantic.Field()
- """
- The id of the component clicked by the teammate to trigger the request.
- """
-
- context: Context = pydantic.Field()
- """
- The context of where the app is added, where the user last visited, and information on the Messenger settings.
- """
-
- conversation: Conversation = pydantic.Field()
- """
- The conversation where your app is being shown.
- """
-
- current_canvas: CurrentCanvas = pydantic.Field()
- """
- The current canvas the teammate can see.
- """
-
- contact: Contact = pydantic.Field()
- """
- The contact which is currently being viewed by the teammate in the conversation details panel.
- """
-
- input_values: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
- """
- A list of key/value pairs of data, inputted by the teammate on the current canvas.
- """
-
- user: Contact = pydantic.Field()
- """
- The user who took the action.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/submit_response.py b/src/intercom/types/submit_response.py
deleted file mode 100644
index 3e04cf1..0000000
--- a/src/intercom/types/submit_response.py
+++ /dev/null
@@ -1,47 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-from .canvas_object import CanvasObject
-from .event import Event
-
-
-class SubmitResponse(UncheckedBaseModel):
- """
- The response object returned when submitting an app interaction. This will replace the previous canvas that was visible until the app was interacted with.
-
- You can optionally provide an event object with the attribute `type` given as `completed` to tell us if the app has completed its purpose. For example, an email collector app would be complete when the end-user submits their email address.
-
- Apps in conversation details can also optionally insert an app into the conversation reply:
-
- 1. You respond with a card_creation_options object (https://developers.intercom.com/canvas-kit-reference/reference/card-creation-options)
- 2. We send a request to the initialize URL for Messenger capabilities (https://developers.intercom.com/docs/build-an-integration/getting-started/build-an-app-for-your-messenger/request-flows) with the card_creation_options object present
- 3. You respond with a canvas object with the components you want to insert into the conversation reply
- """
-
- canvas: CanvasObject = pydantic.Field()
- """
- The canvas object that defines the new UI to be shown.
- """
-
- card_creation_options: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
- """
- Optional. Key-value pairs that will be sent in the initialize request to insert an app into the conversation reply.
- """
-
- event: typing.Optional[Event] = pydantic.Field(default=None)
- """
- Optional. Indicates if the app has completed its purpose.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/subscription_type_list.py b/src/intercom/types/subscription_type_list.py
index c6e39c2..b0d2596 100644
--- a/src/intercom/types/subscription_type_list.py
+++ b/src/intercom/types/subscription_type_list.py
@@ -13,12 +13,12 @@ class SubscriptionTypeList(UncheckedBaseModel):
A list of subscription type objects.
"""
- type: typing.Literal["list"] = pydantic.Field(default="list")
+ type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None)
"""
The type of the object
"""
- data: typing.List[SubscriptionType] = pydantic.Field()
+ data: typing.Optional[typing.List[SubscriptionType]] = pydantic.Field(default=None)
"""
A list of subscription type objects associated with the workspace .
"""
diff --git a/src/intercom/types/tag_list.py b/src/intercom/types/tag_list.py
index 3ad1c5d..5a1776c 100644
--- a/src/intercom/types/tag_list.py
+++ b/src/intercom/types/tag_list.py
@@ -13,12 +13,12 @@ class TagList(UncheckedBaseModel):
A list of tags objects in the workspace.
"""
- type: typing.Literal["list"] = pydantic.Field(default="list")
+ type: typing.Optional[typing.Literal["list"]] = pydantic.Field(default=None)
"""
The type of the object
"""
- data: typing.List[Tag] = pydantic.Field()
+ data: typing.Optional[typing.List[Tag]] = pydantic.Field(default=None)
"""
A list of tags objects associated with the workspace .
"""
diff --git a/src/intercom/types/tags.py b/src/intercom/types/tags.py
index 341ec73..3989c55 100644
--- a/src/intercom/types/tags.py
+++ b/src/intercom/types/tags.py
@@ -13,12 +13,12 @@ class Tags(UncheckedBaseModel):
A list of tags objects associated with a conversation
"""
- type: typing.Literal["tag.list"] = pydantic.Field(default="tag.list")
+ type: typing.Optional[typing.Literal["tag.list"]] = pydantic.Field(default=None)
"""
The type of the object
"""
- tags: typing.List[Tag] = pydantic.Field()
+ tags: typing.Optional[typing.List[Tag]] = pydantic.Field(default=None)
"""
A list of tags objects associated with the conversation.
"""
diff --git a/src/intercom/types/team_list.py b/src/intercom/types/team_list.py
index e4e69ed..52bb029 100644
--- a/src/intercom/types/team_list.py
+++ b/src/intercom/types/team_list.py
@@ -13,12 +13,12 @@ class TeamList(UncheckedBaseModel):
This will return a list of team objects for the App.
"""
- type: typing.Literal["team.list"] = pydantic.Field(default="team.list")
+ type: typing.Optional[typing.Literal["team.list"]] = pydantic.Field(default=None)
"""
The type of the object
"""
- teams: typing.List[Team] = pydantic.Field()
+ teams: typing.Optional[typing.List[Team]] = pydantic.Field(default=None)
"""
A list of team objects
"""
diff --git a/src/intercom/types/text_area_component.py b/src/intercom/types/text_area_component.py
deleted file mode 100644
index 9f7263e..0000000
--- a/src/intercom/types/text_area_component.py
+++ /dev/null
@@ -1,54 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-
-
-class TextAreaComponent(UncheckedBaseModel):
- """
- A text area component is used to capture a large amount of text as input with a multi-line text box. You can submit the value of the text area by:
-
- - Using a ButtonComponent (which will submit all interactive components in the canvas)
- """
-
- id: str = pydantic.Field()
- """
- A unique identifier for the component.
- """
-
- label: typing.Optional[str] = pydantic.Field(default=None)
- """
- The text shown above the text area.
- """
-
- placeholder: typing.Optional[str] = pydantic.Field(default=None)
- """
- An example value shown inside the component when it's empty.
- """
-
- value: typing.Optional[str] = pydantic.Field(default=None)
- """
- An entered value which is already inside the component.
- """
-
- error: typing.Optional[bool] = pydantic.Field(default=None)
- """
- Styles the input as failed. Default is false.
- """
-
- disabled: typing.Optional[bool] = pydantic.Field(default=None)
- """
- Styles the input and prevents the action. Default is false.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/text_component.py b/src/intercom/types/text_component.py
deleted file mode 100644
index a08dda6..0000000
--- a/src/intercom/types/text_component.py
+++ /dev/null
@@ -1,49 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from ..core.unchecked_base_model import UncheckedBaseModel
-from .text_component_align import TextComponentAlign
-from .text_component_style import TextComponentStyle
-
-
-class TextComponent(UncheckedBaseModel):
- """
- A text component is used for rendering blocks of text. Links and bold font can be rendered through Markdown. There are different styles provided which edit the color, weight, and font size. These cannot be edited through Markdown.
- """
-
- id: typing.Optional[str] = pydantic.Field(default=None)
- """
- A unique identifier for the component.
- """
-
- text: str = pydantic.Field()
- """
- The text that will be rendered.
- """
-
- align: typing.Optional[TextComponentAlign] = pydantic.Field(default=None)
- """
- Aligns the text. Default is `left`.
- """
-
- style: typing.Optional[TextComponentStyle] = pydantic.Field(default=None)
- """
- Styles the text. Default is `paragraph`.
- """
-
- bottom_margin: typing.Optional[typing.Literal["none"]] = pydantic.Field(default=None)
- """
- Disables a component's margin-bottom of 10px.
- """
-
- if IS_PYDANTIC_V2:
- model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
- else:
-
- class Config:
- frozen = True
- smart_union = True
- extra = pydantic.Extra.allow
diff --git a/src/intercom/types/text_component_align.py b/src/intercom/types/text_component_align.py
deleted file mode 100644
index 0ba0243..0000000
--- a/src/intercom/types/text_component_align.py
+++ /dev/null
@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-TextComponentAlign = typing.Union[typing.Literal["left", "center", "right"], typing.Any]
diff --git a/src/intercom/types/text_component_style.py b/src/intercom/types/text_component_style.py
deleted file mode 100644
index a2d0aa9..0000000
--- a/src/intercom/types/text_component_style.py
+++ /dev/null
@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-TextComponentStyle = typing.Union[typing.Literal["header", "paragraph", "muted", "error"], typing.Any]
diff --git a/src/intercom/types/ticket_list.py b/src/intercom/types/ticket_list.py
index bb24c3e..5e6669e 100644
--- a/src/intercom/types/ticket_list.py
+++ b/src/intercom/types/ticket_list.py
@@ -14,17 +14,17 @@ class TicketList(UncheckedBaseModel):
Tickets are how you track requests from your users.
"""
- type: typing.Literal["ticket.list"] = pydantic.Field(default="ticket.list")
+ type: typing.Optional[typing.Literal["ticket.list"]] = pydantic.Field(default=None)
"""
Always ticket.list
"""
- tickets: typing.List[Ticket] = pydantic.Field()
+ tickets: typing.Optional[typing.List[typing.Optional[Ticket]]] = pydantic.Field(default=None)
"""
The list of ticket objects
"""
- total_count: int = pydantic.Field()
+ total_count: typing.Optional[int] = pydantic.Field(default=None)
"""
A count of the total number of objects.
"""
diff --git a/src/intercom/types/ticket_part_author.py b/src/intercom/types/ticket_part_author.py
index 0412078..c0538d1 100644
--- a/src/intercom/types/ticket_part_author.py
+++ b/src/intercom/types/ticket_part_author.py
@@ -13,12 +13,12 @@ class TicketPartAuthor(UncheckedBaseModel):
The author that wrote or triggered the part. Can be a bot, admin, team or user.
"""
- type: TicketPartAuthorType = pydantic.Field()
+ type: typing.Optional[TicketPartAuthorType] = pydantic.Field(default=None)
"""
The type of the author
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The id of the author
"""
@@ -28,7 +28,7 @@ class TicketPartAuthor(UncheckedBaseModel):
The name of the author
"""
- email: str = pydantic.Field()
+ email: typing.Optional[str] = pydantic.Field(default=None)
"""
The email of the author
"""
diff --git a/src/intercom/types/ticket_parts.py b/src/intercom/types/ticket_parts.py
index 8957065..230a1bf 100644
--- a/src/intercom/types/ticket_parts.py
+++ b/src/intercom/types/ticket_parts.py
@@ -13,17 +13,17 @@ class TicketParts(UncheckedBaseModel):
A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.
"""
- type: typing.Literal["ticket_part.list"] = pydantic.Field(default="ticket_part.list")
+ type: typing.Optional[typing.Literal["ticket_part.list"]] = pydantic.Field(default=None)
"""
"""
- ticket_parts: typing.List[TicketPart] = pydantic.Field()
+ ticket_parts: typing.Optional[typing.List[TicketPart]] = pydantic.Field(default=None)
"""
A list of Ticket Part objects for each ticket. There is a limit of 500 parts.
"""
- total_count: int = pydantic.Field()
+ total_count: typing.Optional[int] = pydantic.Field(default=None)
"""
"""
diff --git a/src/intercom/types/ticket_reply.py b/src/intercom/types/ticket_reply.py
index d55ee84..ec2ab74 100644
--- a/src/intercom/types/ticket_reply.py
+++ b/src/intercom/types/ticket_reply.py
@@ -15,17 +15,17 @@ class TicketReply(UncheckedBaseModel):
A Ticket Part representing a note, comment, or quick_reply on a ticket
"""
- type: typing.Literal["ticket_part"] = pydantic.Field(default="ticket_part")
+ type: typing.Optional[typing.Literal["ticket_part"]] = pydantic.Field(default=None)
"""
Always ticket_part
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The id representing the part.
"""
- part_type: TicketReplyPartType = pydantic.Field()
+ part_type: typing.Optional[TicketReplyPartType] = pydantic.Field(default=None)
"""
Type of the part
"""
@@ -35,7 +35,7 @@ class TicketReply(UncheckedBaseModel):
The message body, which may contain HTML.
"""
- created_at: int = pydantic.Field()
+ created_at: typing.Optional[int] = pydantic.Field(default=None)
"""
The time the note was created.
"""
diff --git a/src/intercom/types/ticket_state_list.py b/src/intercom/types/ticket_state_list.py
new file mode 100644
index 0000000..b70ef5a
--- /dev/null
+++ b/src/intercom/types/ticket_state_list.py
@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from ..tickets.types.ticket_state_detailed import TicketStateDetailed
+
+
+class TicketStateList(UncheckedBaseModel):
+ """
+ A list of ticket states associated with a given ticket type.
+ """
+
+ type: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ String representing the object's type. Always has the value `list`.
+ """
+
+ data: typing.Optional[typing.List[typing.Optional[TicketStateDetailed]]] = pydantic.Field(default=None)
+ """
+ A list of ticket states associated with a given ticket type.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/ticket_type_attribute.py b/src/intercom/types/ticket_type_attribute.py
index 60141c0..e22b670 100644
--- a/src/intercom/types/ticket_type_attribute.py
+++ b/src/intercom/types/ticket_type_attribute.py
@@ -13,82 +13,82 @@ class TicketTypeAttribute(UncheckedBaseModel):
Ticket type attribute, used to define each data field to be captured in a ticket.
"""
- type: typing.Literal["ticket_type_attribute"] = pydantic.Field(default="ticket_type_attribute")
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
String representing the object's type. Always has the value `ticket_type_attribute`.
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The id representing the ticket type attribute.
"""
- workspace_id: str = pydantic.Field()
+ workspace_id: typing.Optional[str] = pydantic.Field(default=None)
"""
The id of the workspace that the ticket type attribute belongs to.
"""
- name: str = pydantic.Field()
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
The name of the ticket type attribute
"""
- description: str = pydantic.Field()
+ description: typing.Optional[str] = pydantic.Field(default=None)
"""
The description of the ticket type attribute
"""
- data_type: TicketTypeAttributeDataType = pydantic.Field()
+ data_type: typing.Optional[TicketTypeAttributeDataType] = pydantic.Field(default=None)
"""
The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")
"""
- input_options: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
+ input_options: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
"""
Input options for the attribute
"""
- order: int = pydantic.Field()
+ order: typing.Optional[int] = pydantic.Field(default=None)
"""
The order of the attribute against other attributes
"""
- required_to_create: bool = pydantic.Field()
+ required_to_create: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether the attribute is required or not for teammates.
"""
- required_to_create_for_contacts: bool = pydantic.Field()
+ required_to_create_for_contacts: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether the attribute is required or not for contacts.
"""
- visible_on_create: bool = pydantic.Field()
+ visible_on_create: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether the attribute is visible or not to teammates.
"""
- visible_to_contacts: bool = pydantic.Field()
+ visible_to_contacts: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether the attribute is visible or not to contacts.
"""
- default: bool = pydantic.Field()
+ default: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether the attribute is built in or not.
"""
- ticket_type_id: int = pydantic.Field()
+ ticket_type_id: typing.Optional[int] = pydantic.Field(default=None)
"""
The id of the ticket type that the attribute belongs to.
"""
- archived: bool = pydantic.Field()
+ archived: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether the ticket type attribute is archived or not.
"""
- created_at: int = pydantic.Field()
+ created_at: typing.Optional[int] = pydantic.Field(default=None)
"""
The date and time the ticket type attribute was created.
"""
diff --git a/src/intercom/types/ticket_type_attribute_list.py b/src/intercom/types/ticket_type_attribute_list.py
index c707631..b74b43b 100644
--- a/src/intercom/types/ticket_type_attribute_list.py
+++ b/src/intercom/types/ticket_type_attribute_list.py
@@ -13,12 +13,14 @@ class TicketTypeAttributeList(UncheckedBaseModel):
A list of attributes associated with a given ticket type.
"""
- type: typing.Literal["ticket_type_attributes.list"] = pydantic.Field(default="ticket_type_attributes.list")
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
String representing the object's type. Always has the value `ticket_type_attributes.list`.
"""
- ticket_type_attributes: typing.List[TicketTypeAttribute] = pydantic.Field()
+ ticket_type_attributes: typing.Optional[typing.List[typing.Optional[TicketTypeAttribute]]] = pydantic.Field(
+ default=None
+ )
"""
A list of ticket type attributes associated with a given ticket type.
"""
diff --git a/src/intercom/types/ticket_type_list.py b/src/intercom/types/ticket_type_list.py
index 098c902..6971149 100644
--- a/src/intercom/types/ticket_type_list.py
+++ b/src/intercom/types/ticket_type_list.py
@@ -13,12 +13,12 @@ class TicketTypeList(UncheckedBaseModel):
A list of ticket types associated with a given workspace.
"""
- type: typing.Literal["ticket_type_attributes.list"] = pydantic.Field(default="ticket_type_attributes.list")
+ type: typing.Optional[str] = pydantic.Field(default=None)
"""
- String representing the object's type. Always has the value `ticket_type.list`.
+ String representing the object's type. Always has the value `list`.
"""
- ticket_types: typing.List[TicketType] = pydantic.Field()
+ data: typing.Optional[typing.List[typing.Optional[TicketType]]] = pydantic.Field(default=None)
"""
A list of ticket_types associated with a given workspace.
"""
diff --git a/src/intercom/types/translation.py b/src/intercom/types/translation.py
index a2b14e9..9b10833 100644
--- a/src/intercom/types/translation.py
+++ b/src/intercom/types/translation.py
@@ -12,17 +12,17 @@ class Translation(UncheckedBaseModel):
A translation object contains the localised details of a subscription type.
"""
- name: str = pydantic.Field()
+ name: typing.Optional[str] = pydantic.Field(default=None)
"""
The localised name of the subscription type.
"""
- description: str = pydantic.Field()
+ description: typing.Optional[str] = pydantic.Field(default=None)
"""
The localised description of the subscription type.
"""
- locale: str = pydantic.Field()
+ locale: typing.Optional[str] = pydantic.Field(default=None)
"""
The two character identifier for the language of the translation object.
"""
diff --git a/src/intercom/types/untag_company_request_companies_item.py b/src/intercom/types/untag_company_request_companies_item.py
index f7ec650..b87a55f 100644
--- a/src/intercom/types/untag_company_request_companies_item.py
+++ b/src/intercom/types/untag_company_request_companies_item.py
@@ -8,17 +8,17 @@
class UntagCompanyRequestCompaniesItem(UncheckedBaseModel):
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The Intercom defined id representing the company.
"""
- company_id: str = pydantic.Field()
+ company_id: typing.Optional[str] = pydantic.Field(default=None)
"""
The company id you have defined for the company.
"""
- untag: typing.Literal[True] = pydantic.Field(default=True)
+ untag: typing.Optional[bool] = pydantic.Field(default=None)
"""
Always set to true
"""
diff --git a/src/intercom/types/update_article_request_body.py b/src/intercom/types/update_article_request_body.py
new file mode 100644
index 0000000..58fb436
--- /dev/null
+++ b/src/intercom/types/update_article_request_body.py
@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .update_article_request_body_parent_type import UpdateArticleRequestBodyParentType
+
+
+class UpdateArticleRequestBody(UncheckedBaseModel):
+ parent_type: typing.Optional[UpdateArticleRequestBodyParentType] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/articles/types/update_article_request_body_parent_type.py b/src/intercom/types/update_article_request_body_parent_type.py
similarity index 100%
rename from src/intercom/articles/types/update_article_request_body_parent_type.py
rename to src/intercom/types/update_article_request_body_parent_type.py
diff --git a/src/intercom/types/update_data_attribute_request_body.py b/src/intercom/types/update_data_attribute_request_body.py
new file mode 100644
index 0000000..c2e56ce
--- /dev/null
+++ b/src/intercom/types/update_data_attribute_request_body.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .update_data_attribute_request_options import UpdateDataAttributeRequestOptions
+
+UpdateDataAttributeRequestBody = typing.Union[UpdateDataAttributeRequestOptions, typing.Optional[typing.Any]]
diff --git a/src/intercom/types/update_data_attribute_request_options.py b/src/intercom/types/update_data_attribute_request_options.py
new file mode 100644
index 0000000..1fd40c3
--- /dev/null
+++ b/src/intercom/types/update_data_attribute_request_options.py
@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .update_data_attribute_request_options_options_item import UpdateDataAttributeRequestOptionsOptionsItem
+
+
+class UpdateDataAttributeRequestOptions(UncheckedBaseModel):
+ options: typing.List[UpdateDataAttributeRequestOptionsOptionsItem] = pydantic.Field()
+ """
+ Array of objects representing the options of the list, with `value` as the key and the option as the value. At least two options are required.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/update_data_attribute_request_options_options_item.py b/src/intercom/types/update_data_attribute_request_options_options_item.py
new file mode 100644
index 0000000..42bce4e
--- /dev/null
+++ b/src/intercom/types/update_data_attribute_request_options_options_item.py
@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class UpdateDataAttributeRequestOptionsOptionsItem(UncheckedBaseModel):
+ value: typing.Optional[str] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/visitor.py b/src/intercom/types/visitor.py
index d5b780b..f8493f4 100644
--- a/src/intercom/types/visitor.py
+++ b/src/intercom/types/visitor.py
@@ -18,27 +18,27 @@ class Visitor(UncheckedBaseModel):
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.
"""
- type: typing.Literal["visitor"] = pydantic.Field(default="visitor")
+ type: typing.Optional[typing.Literal["visitor"]] = pydantic.Field(default=None)
"""
Value is 'visitor'
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The Intercom defined id representing the Visitor.
"""
- user_id: str = pydantic.Field()
+ user_id: typing.Optional[str] = pydantic.Field(default=None)
"""
Automatically generated identifier for the Visitor.
"""
- anonymous: bool = pydantic.Field()
+ anonymous: typing.Optional[bool] = pydantic.Field(default=None)
"""
Identifies if this visitor is anonymous.
"""
- email: str = pydantic.Field()
+ email: typing.Optional[str] = pydantic.Field(default=None)
"""
The email of the visitor.
"""
@@ -59,7 +59,7 @@ class Visitor(UncheckedBaseModel):
"""
avatar: typing.Optional[VisitorAvatar] = None
- app_id: str = pydantic.Field()
+ app_id: typing.Optional[str] = pydantic.Field(default=None)
"""
The id of the app the visitor is associated with.
"""
@@ -71,7 +71,7 @@ class Visitor(UncheckedBaseModel):
The time the Lead last recorded making a request.
"""
- created_at: int = pydantic.Field()
+ created_at: typing.Optional[int] = pydantic.Field(default=None)
"""
The time the Visitor was added to Intercom.
"""
@@ -81,7 +81,7 @@ class Visitor(UncheckedBaseModel):
The time the Visitor was added to Intercom.
"""
- signed_up_at: int = pydantic.Field()
+ signed_up_at: typing.Optional[int] = pydantic.Field(default=None)
"""
The time the Visitor signed up for your product.
"""
diff --git a/src/intercom/types/visitor_deleted_object.py b/src/intercom/types/visitor_deleted_object.py
index f2cc5b2..1246b34 100644
--- a/src/intercom/types/visitor_deleted_object.py
+++ b/src/intercom/types/visitor_deleted_object.py
@@ -12,17 +12,17 @@ class VisitorDeletedObject(UncheckedBaseModel):
Response returned when an object is deleted
"""
- id: str = pydantic.Field()
+ id: typing.Optional[str] = pydantic.Field(default=None)
"""
The unique identifier for the visitor which is given by Intercom.
"""
- type: typing.Literal["visitor"] = pydantic.Field(default="visitor")
+ type: typing.Optional[typing.Literal["visitor"]] = pydantic.Field(default=None)
"""
The type of object which was deleted
"""
- user_id: str = pydantic.Field()
+ user_id: typing.Optional[str] = pydantic.Field(default=None)
"""
Automatically generated identifier for the Visitor.
"""
diff --git a/src/intercom/types/whatsapp_message_status_list.py b/src/intercom/types/whatsapp_message_status_list.py
new file mode 100644
index 0000000..fcadc4b
--- /dev/null
+++ b/src/intercom/types/whatsapp_message_status_list.py
@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .whatsapp_message_status_list_events_item import WhatsappMessageStatusListEventsItem
+from .whatsapp_message_status_list_pages import WhatsappMessageStatusListPages
+
+
+class WhatsappMessageStatusList(UncheckedBaseModel):
+ type: typing.Literal["list"] = "list"
+ ruleset_id: str = pydantic.Field()
+ """
+ The provided ruleset ID
+ """
+
+ pages: WhatsappMessageStatusListPages
+ total_count: int = pydantic.Field()
+ """
+ Total number of events
+ """
+
+ events: typing.List[WhatsappMessageStatusListEventsItem]
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/whatsapp_message_status_list_events_item.py b/src/intercom/types/whatsapp_message_status_list_events_item.py
new file mode 100644
index 0000000..19ec9f8
--- /dev/null
+++ b/src/intercom/types/whatsapp_message_status_list_events_item.py
@@ -0,0 +1,59 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .whatsapp_message_status_list_events_item_status import WhatsappMessageStatusListEventsItemStatus
+
+
+class WhatsappMessageStatusListEventsItem(UncheckedBaseModel):
+ id: str = pydantic.Field()
+ """
+ Event ID
+ """
+
+ conversation_id: str = pydantic.Field()
+ """
+ ID of the conversation
+ """
+
+ status: WhatsappMessageStatusListEventsItemStatus = pydantic.Field()
+ """
+ Current status of the message
+ """
+
+ type: typing.Literal["broadcast_outbound"] = pydantic.Field(default="broadcast_outbound")
+ """
+ Event type
+ """
+
+ created_at: int = pydantic.Field()
+ """
+ Creation timestamp
+ """
+
+ updated_at: int = pydantic.Field()
+ """
+ Last update timestamp
+ """
+
+ whatsapp_message_id: str = pydantic.Field()
+ """
+ WhatsApp's message identifier
+ """
+
+ template_name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Name of the WhatsApp template used
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/types/whatsapp_message_status_list_events_item_status.py b/src/intercom/types/whatsapp_message_status_list_events_item_status.py
new file mode 100644
index 0000000..3db079a
--- /dev/null
+++ b/src/intercom/types/whatsapp_message_status_list_events_item_status.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+WhatsappMessageStatusListEventsItemStatus = typing.Union[
+ typing.Literal["sent", "delivered", "read", "failed"], typing.Any
+]
diff --git a/src/intercom/types/configure_request_zero.py b/src/intercom/types/whatsapp_message_status_list_pages.py
similarity index 53%
rename from src/intercom/types/configure_request_zero.py
rename to src/intercom/types/whatsapp_message_status_list_pages.py
index 46bef93..5af4f33 100644
--- a/src/intercom/types/configure_request_zero.py
+++ b/src/intercom/types/whatsapp_message_status_list_pages.py
@@ -3,26 +3,26 @@
import typing
import pydantic
-from ..admins.types.admin import Admin
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
-from .context import Context
+from .whatsapp_message_status_list_pages_next import WhatsappMessageStatusListPagesNext
-class ConfigureRequestZero(UncheckedBaseModel):
- workspace_id: str = pydantic.Field()
+class WhatsappMessageStatusListPages(UncheckedBaseModel):
+ type: typing.Literal["pages"] = "pages"
+ per_page: int = pydantic.Field()
"""
- The workspace ID of the teammate. Attribute is app_id for V1.2 and below.
+ Number of results per page
"""
- admin: Admin = pydantic.Field()
+ total_pages: int = pydantic.Field()
"""
- The Intercom teammate configuring the app.
+ Total number of pages
"""
- context: Context = pydantic.Field()
+ next: typing.Optional[WhatsappMessageStatusListPagesNext] = pydantic.Field(default=None)
"""
- The context of where the app is added, where the user last visited, and information on the Messenger settings.
+ Information for fetching next page (null if no more pages)
"""
if IS_PYDANTIC_V2:
diff --git a/src/intercom/types/whatsapp_message_status_list_pages_next.py b/src/intercom/types/whatsapp_message_status_list_pages_next.py
new file mode 100644
index 0000000..c9974e5
--- /dev/null
+++ b/src/intercom/types/whatsapp_message_status_list_pages_next.py
@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class WhatsappMessageStatusListPagesNext(UncheckedBaseModel):
+ """
+ Information for fetching next page (null if no more pages)
+ """
+
+ starting_after: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Cursor for the next page
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/unstable/__init__.py b/src/intercom/unstable/__init__.py
index d7f4dd4..f392994 100644
--- a/src/intercom/unstable/__init__.py
+++ b/src/intercom/unstable/__init__.py
@@ -27,6 +27,7 @@
AssignConversationRequest,
AssignConversationRequestType,
AwayStatusReason,
+ CallList,
CloseConversationRequest,
CollectionList,
CompanyAttachedContacts,
@@ -83,7 +84,17 @@
ConversationSourceType,
ConversationStatistics,
ConversationTeammates,
+ CreateArticleRequest,
+ CreateArticleRequestState,
+ CreateDataAttributeRequest,
+ CreateDataAttributeRequestOne,
+ CreateDataAttributeRequestOneDataType,
+ CreateDataAttributeRequestOptions,
+ CreateDataAttributeRequestOptionsOptionsItem,
+ CreateInternalArticleRequest,
+ CreateOrUpdateCompanyRequest,
CreateOrUpdateTagRequest,
+ CreatePhoneSwitchRequest,
CreateTicketReplyWithCommentRequest,
CreateTicketRequestAssignment,
CreateTicketRequestBody,
@@ -91,6 +102,8 @@
CreateTicketRequestContactsItemEmail,
CreateTicketRequestContactsItemExternalId,
CreateTicketRequestContactsItemId,
+ CreateTicketTypeRequest,
+ CreateTicketTypeRequestCategory,
CursorPages,
CustomActionFinished,
CustomActionFinishedAction,
@@ -120,6 +133,7 @@
DeletedArticleObject,
DeletedCollectionObject,
DeletedCompanyObject,
+ DeletedInternalArticleObject,
DeletedObject,
EmailAddressHeader,
EmailMessageMetadata,
@@ -131,6 +145,7 @@
GroupTranslatedContent,
IntercomVersion,
IntercomVersionUnstable,
+ InternalArticleList,
LinkedObject,
LinkedObjectList,
LinkedObjectType,
@@ -202,10 +217,9 @@
Translation,
UntagCompanyRequest,
UntagCompanyRequestCompaniesItem,
- UpdateArticleRequestBody,
- UpdateArticleRequestState,
- UpdateTicketTypeRequestBody,
- UpdateTicketTypeRequestCategory,
+ UpdateDataAttributeRequestBody,
+ UpdateDataAttributeRequestOptions,
+ UpdateDataAttributeRequestOptionsOptionsItem,
Visitor,
VisitorAvatar,
VisitorCompanies,
@@ -237,6 +251,8 @@
ai_content_source,
articles,
away_status_reasons,
+ brands,
+ calls,
companies,
contacts,
conversations,
@@ -245,9 +261,12 @@
data_attributes,
data_events,
data_export,
+ emails,
export,
help_center,
+ internal_articles,
jobs,
+ macros,
messages,
news,
notes,
@@ -287,7 +306,10 @@
ArticleSearchHighlightsHighlightedTitleItemType,
ArticleSearchResponse,
ArticleSearchResponseData,
+ InternalArticle,
)
+from .brands import Brand, BrandList
+from .calls import Call, ListCallsWithTranscriptsResponse, ListCallsWithTranscriptsResponseDataItem
from .companies import Company, CompanyPlan, CompanySegments, CompanyTags
from .contacts import (
Contact,
@@ -315,14 +337,7 @@
ManageConversationRequestBody_Snoozed,
)
from .custom_object_instances import CustomObjectInstance
-from .data_attributes import (
- CreateDataAttributeRequestDataType,
- CreateDataAttributeRequestModel,
- DataAttribute,
- DataAttributeDataType,
- DataAttributeModel,
- LisDataAttributesRequestModel,
-)
+from .data_attributes import DataAttribute, DataAttributeDataType, DataAttributeModel, LisDataAttributesRequestModel
from .data_events import (
CreateDataEventSummariesRequestEventSummaries,
DataEvent,
@@ -332,6 +347,7 @@
LisDataEventsRequestFilterUserId,
)
from .data_export import DataExport, DataExportStatus
+from .emails import EmailList, EmailSetting
from .export import (
GetExportReportingDataGetDatasetsResponse,
GetExportReportingDataGetDatasetsResponseDataItem,
@@ -339,7 +355,9 @@
PostExportReportingDataEnqueueResponse,
)
from .help_center import Collection, HelpCenter, HelpCenterList
+from .internal_articles import InternalArticleListItem, InternalArticleSearchResponse, InternalArticleSearchResponseData
from .jobs import Jobs, JobsStatus
+from .macros import Macro, MacroAvailableOnItem, MacroList, MacroListPages, MacroListPagesNext, MacroVisibleTo
from .messages import Message, MessageMessageType
from .news import NewsItem, NewsItemState, Newsfeed, NewsfeedAssignment
from .notes import Note, NoteContact
@@ -420,6 +438,10 @@
"AttachContactToConversationRequestCustomerUserId",
"AwayStatusReason",
"BadRequestError",
+ "Brand",
+ "BrandList",
+ "Call",
+ "CallList",
"CloseConversationRequest",
"Collection",
"CollectionList",
@@ -492,14 +514,22 @@
"ConversationState",
"ConversationStatistics",
"ConversationTeammates",
+ "CreateArticleRequest",
+ "CreateArticleRequestState",
"CreateContactResponse",
"CreateContentImportSourceRequestStatus",
"CreateConversationRequestFrom",
"CreateConversationRequestFromType",
- "CreateDataAttributeRequestDataType",
- "CreateDataAttributeRequestModel",
+ "CreateDataAttributeRequest",
+ "CreateDataAttributeRequestOne",
+ "CreateDataAttributeRequestOneDataType",
+ "CreateDataAttributeRequestOptions",
+ "CreateDataAttributeRequestOptionsOptionsItem",
"CreateDataEventSummariesRequestEventSummaries",
+ "CreateInternalArticleRequest",
+ "CreateOrUpdateCompanyRequest",
"CreateOrUpdateTagRequest",
+ "CreatePhoneSwitchRequest",
"CreateTagRequestBody",
"CreateTicketReplyWithCommentRequest",
"CreateTicketRequestAssignment",
@@ -509,6 +539,8 @@
"CreateTicketRequestContactsItemExternalId",
"CreateTicketRequestContactsItemId",
"CreateTicketTypeAttributeRequestDataType",
+ "CreateTicketTypeRequest",
+ "CreateTicketTypeRequestCategory",
"CursorPages",
"CustomActionFinished",
"CustomActionFinishedAction",
@@ -546,9 +578,12 @@
"DeletedArticleObject",
"DeletedCollectionObject",
"DeletedCompanyObject",
+ "DeletedInternalArticleObject",
"DeletedObject",
"EmailAddressHeader",
+ "EmailList",
"EmailMessageMetadata",
+ "EmailSetting",
"Error",
"ErrorErrorsItem",
"EventDetails",
@@ -565,6 +600,11 @@
"HelpCenterList",
"IntercomVersion",
"IntercomVersionUnstable",
+ "InternalArticle",
+ "InternalArticleList",
+ "InternalArticleListItem",
+ "InternalArticleSearchResponse",
+ "InternalArticleSearchResponseData",
"InternalServerError",
"Jobs",
"JobsStatus",
@@ -576,6 +616,14 @@
"LisDataEventsRequestFilterEmail",
"LisDataEventsRequestFilterIntercomUserId",
"LisDataEventsRequestFilterUserId",
+ "ListCallsWithTranscriptsResponse",
+ "ListCallsWithTranscriptsResponseDataItem",
+ "Macro",
+ "MacroAvailableOnItem",
+ "MacroList",
+ "MacroListPages",
+ "MacroListPagesNext",
+ "MacroVisibleTo",
"ManageConversationRequestBody",
"ManageConversationRequestBody_Assignment",
"ManageConversationRequestBody_Close",
@@ -694,13 +742,12 @@
"UnprocessableEntityError",
"UntagCompanyRequest",
"UntagCompanyRequestCompaniesItem",
- "UpdateArticleRequestBody",
- "UpdateArticleRequestState",
"UpdateContactResponse",
"UpdateContentImportSourceRequestStatus",
"UpdateContentImportSourceRequestSyncBehavior",
- "UpdateTicketTypeRequestBody",
- "UpdateTicketTypeRequestCategory",
+ "UpdateDataAttributeRequestBody",
+ "UpdateDataAttributeRequestOptions",
+ "UpdateDataAttributeRequestOptionsOptionsItem",
"Visitor",
"VisitorAvatar",
"VisitorCompanies",
@@ -721,6 +768,8 @@
"ai_content_source",
"articles",
"away_status_reasons",
+ "brands",
+ "calls",
"companies",
"contacts",
"conversations",
@@ -729,9 +778,12 @@
"data_attributes",
"data_events",
"data_export",
+ "emails",
"export",
"help_center",
+ "internal_articles",
"jobs",
+ "macros",
"messages",
"news",
"notes",
diff --git a/src/intercom/unstable/ai_agent/types/ai_agent.py b/src/intercom/unstable/ai_agent/types/ai_agent.py
index 3c61c27..38e16fd 100644
--- a/src/intercom/unstable/ai_agent/types/ai_agent.py
+++ b/src/intercom/unstable/ai_agent/types/ai_agent.py
@@ -44,6 +44,16 @@ class AiAgent(UncheckedBaseModel):
The customer satisfaction rating remark given to AI Agent.
"""
+ created_at: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ The time when the AI agent rating was created.
+ """
+
+ updated_at: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ The time when the AI agent rating was last updated.
+ """
+
content_sources: typing.Optional[ContentSourcesList] = None
if IS_PYDANTIC_V2:
diff --git a/src/intercom/unstable/articles/__init__.py b/src/intercom/unstable/articles/__init__.py
index f8adce5..4874009 100644
--- a/src/intercom/unstable/articles/__init__.py
+++ b/src/intercom/unstable/articles/__init__.py
@@ -13,6 +13,7 @@
ArticleSearchHighlightsHighlightedTitleItemType,
ArticleSearchResponse,
ArticleSearchResponseData,
+ InternalArticle,
)
__all__ = [
@@ -26,4 +27,5 @@
"ArticleSearchHighlightsHighlightedTitleItemType",
"ArticleSearchResponse",
"ArticleSearchResponseData",
+ "InternalArticle",
]
diff --git a/src/intercom/unstable/articles/types/__init__.py b/src/intercom/unstable/articles/types/__init__.py
index 80005c4..3cd8409 100644
--- a/src/intercom/unstable/articles/types/__init__.py
+++ b/src/intercom/unstable/articles/types/__init__.py
@@ -14,6 +14,7 @@
from .article_search_highlights_highlighted_title_item_type import ArticleSearchHighlightsHighlightedTitleItemType
from .article_search_response import ArticleSearchResponse
from .article_search_response_data import ArticleSearchResponseData
+from .internal_article import InternalArticle
__all__ = [
"Article",
@@ -26,4 +27,5 @@
"ArticleSearchHighlightsHighlightedTitleItemType",
"ArticleSearchResponse",
"ArticleSearchResponseData",
+ "InternalArticle",
]
diff --git a/src/intercom/unstable/articles/types/internal_article.py b/src/intercom/unstable/articles/types/internal_article.py
new file mode 100644
index 0000000..3b83a54
--- /dev/null
+++ b/src/intercom/unstable/articles/types/internal_article.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...internal_articles.types.internal_article_list_item import InternalArticleListItem
+
+InternalArticle = InternalArticleListItem
diff --git a/src/intercom/unstable/brands/__init__.py b/src/intercom/unstable/brands/__init__.py
new file mode 100644
index 0000000..c3c2bc5
--- /dev/null
+++ b/src/intercom/unstable/brands/__init__.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import Brand, BrandList
+
+__all__ = ["Brand", "BrandList"]
diff --git a/src/intercom/unstable/brands/client.py b/src/intercom/unstable/brands/client.py
new file mode 100644
index 0000000..d9879b4
--- /dev/null
+++ b/src/intercom/unstable/brands/client.py
@@ -0,0 +1,173 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from .raw_client import AsyncRawBrandsClient, RawBrandsClient
+from .types.brand import Brand
+from .types.brand_list import BrandList
+
+
+class BrandsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._raw_client = RawBrandsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> RawBrandsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ RawBrandsClient
+ """
+ return self._raw_client
+
+ def list_brands(self, *, request_options: typing.Optional[RequestOptions] = None) -> BrandList:
+ """
+ Retrieves all brands for the workspace, including the default brand.
+ The default brand id always matches the workspace
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ BrandList
+ Successful response
+
+ Examples
+ --------
+ from intercom import Intercom
+
+ client = Intercom(
+ token="YOUR_TOKEN",
+ )
+ client.unstable.brands.list_brands()
+ """
+ _response = self._raw_client.list_brands(request_options=request_options)
+ return _response.data
+
+ def retrieve_brand(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Brand:
+ """
+ Fetches a specific brand by its unique identifier
+
+ Parameters
+ ----------
+ id : str
+ The unique identifier of the brand
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ Brand
+ Successful response
+
+ Examples
+ --------
+ from intercom import Intercom
+
+ client = Intercom(
+ token="YOUR_TOKEN",
+ )
+ client.unstable.brands.retrieve_brand(
+ id="id",
+ )
+ """
+ _response = self._raw_client.retrieve_brand(id, request_options=request_options)
+ return _response.data
+
+
+class AsyncBrandsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._raw_client = AsyncRawBrandsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> AsyncRawBrandsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ AsyncRawBrandsClient
+ """
+ return self._raw_client
+
+ async def list_brands(self, *, request_options: typing.Optional[RequestOptions] = None) -> BrandList:
+ """
+ Retrieves all brands for the workspace, including the default brand.
+ The default brand id always matches the workspace
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ BrandList
+ Successful response
+
+ Examples
+ --------
+ import asyncio
+
+ from intercom import AsyncIntercom
+
+ client = AsyncIntercom(
+ token="YOUR_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.unstable.brands.list_brands()
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.list_brands(request_options=request_options)
+ return _response.data
+
+ async def retrieve_brand(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Brand:
+ """
+ Fetches a specific brand by its unique identifier
+
+ Parameters
+ ----------
+ id : str
+ The unique identifier of the brand
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ Brand
+ Successful response
+
+ Examples
+ --------
+ import asyncio
+
+ from intercom import AsyncIntercom
+
+ client = AsyncIntercom(
+ token="YOUR_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.unstable.brands.retrieve_brand(
+ id="id",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.retrieve_brand(id, request_options=request_options)
+ return _response.data
diff --git a/src/intercom/unstable/brands/raw_client.py b/src/intercom/unstable/brands/raw_client.py
new file mode 100644
index 0000000..78016d9
--- /dev/null
+++ b/src/intercom/unstable/brands/raw_client.py
@@ -0,0 +1,242 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.jsonable_encoder import jsonable_encoder
+from ...core.request_options import RequestOptions
+from ...core.unchecked_base_model import construct_type
+from ..errors.not_found_error import NotFoundError
+from ..errors.unauthorized_error import UnauthorizedError
+from ..types.error import Error
+from .types.brand import Brand
+from .types.brand_list import BrandList
+
+
+class RawBrandsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ def list_brands(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[BrandList]:
+ """
+ Retrieves all brands for the workspace, including the default brand.
+ The default brand id always matches the workspace
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[BrandList]
+ Successful response
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ "brands",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ BrandList,
+ construct_type(
+ type_=BrandList, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def retrieve_brand(
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[Brand]:
+ """
+ Fetches a specific brand by its unique identifier
+
+ Parameters
+ ----------
+ id : str
+ The unique identifier of the brand
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[Brand]
+ Successful response
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"brands/{jsonable_encoder(id)}",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ Brand,
+ construct_type(
+ type_=Brand, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawBrandsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ async def list_brands(
+ self, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[BrandList]:
+ """
+ Retrieves all brands for the workspace, including the default brand.
+ The default brand id always matches the workspace
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[BrandList]
+ Successful response
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ "brands",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ BrandList,
+ construct_type(
+ type_=BrandList, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def retrieve_brand(
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[Brand]:
+ """
+ Fetches a specific brand by its unique identifier
+
+ Parameters
+ ----------
+ id : str
+ The unique identifier of the brand
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[Brand]
+ Successful response
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"brands/{jsonable_encoder(id)}",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ Brand,
+ construct_type(
+ type_=Brand, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
diff --git a/src/intercom/unstable/brands/types/__init__.py b/src/intercom/unstable/brands/types/__init__.py
new file mode 100644
index 0000000..6d334db
--- /dev/null
+++ b/src/intercom/unstable/brands/types/__init__.py
@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .brand import Brand
+from .brand_list import BrandList
+
+__all__ = ["Brand", "BrandList"]
diff --git a/src/intercom/unstable/brands/types/brand.py b/src/intercom/unstable/brands/types/brand.py
new file mode 100644
index 0000000..8888094
--- /dev/null
+++ b/src/intercom/unstable/brands/types/brand.py
@@ -0,0 +1,62 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class Brand(UncheckedBaseModel):
+ """
+ Represents a branding configuration for the workspace
+ """
+
+ type: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The type of object
+ """
+
+ id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Unique brand identifier. For default brand, matches the workspace ID
+ """
+
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Display name of the brand
+ """
+
+ is_default: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Whether this is the workspace's default brand
+ """
+
+ created_at: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ Unix timestamp of brand creation
+ """
+
+ updated_at: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ Unix timestamp of last modification
+ """
+
+ help_center_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Associated help center identifier
+ """
+
+ default_address_settings_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Default email settings ID for this brand
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/unstable/brands/types/brand_list.py b/src/intercom/unstable/brands/types/brand_list.py
new file mode 100644
index 0000000..b77a7ce
--- /dev/null
+++ b/src/intercom/unstable/brands/types/brand_list.py
@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .brand import Brand
+
+
+class BrandList(UncheckedBaseModel):
+ """
+ A list of brands
+ """
+
+ type: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The type of object
+ """
+
+ data: typing.Optional[typing.List[Brand]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/unstable/calls/__init__.py b/src/intercom/unstable/calls/__init__.py
new file mode 100644
index 0000000..bf542ca
--- /dev/null
+++ b/src/intercom/unstable/calls/__init__.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import Call, ListCallsWithTranscriptsResponse, ListCallsWithTranscriptsResponseDataItem
+
+__all__ = ["Call", "ListCallsWithTranscriptsResponse", "ListCallsWithTranscriptsResponseDataItem"]
diff --git a/src/intercom/unstable/calls/client.py b/src/intercom/unstable/calls/client.py
new file mode 100644
index 0000000..7432f22
--- /dev/null
+++ b/src/intercom/unstable/calls/client.py
@@ -0,0 +1,417 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ..types.call_list import CallList
+from .raw_client import AsyncRawCallsClient, RawCallsClient
+from .types.call import Call
+from .types.list_calls_with_transcripts_response import ListCallsWithTranscriptsResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class CallsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._raw_client = RawCallsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> RawCallsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ RawCallsClient
+ """
+ return self._raw_client
+
+ def list_calls(
+ self,
+ *,
+ page: typing.Optional[int] = None,
+ per_page: typing.Optional[int] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> CallList:
+ """
+ Retrieve a paginated list of calls.
+
+ Parameters
+ ----------
+ page : typing.Optional[int]
+ The page of results to fetch. Defaults to first page
+
+ per_page : typing.Optional[int]
+ How many results to display per page. Defaults to 25. Max 25.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ CallList
+ successful
+
+ Examples
+ --------
+ from intercom import Intercom
+
+ client = Intercom(
+ token="YOUR_TOKEN",
+ )
+ client.unstable.calls.list_calls()
+ """
+ _response = self._raw_client.list_calls(page=page, per_page=per_page, request_options=request_options)
+ return _response.data
+
+ def show_call(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Call:
+ """
+ Retrieve a single call by id.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call to retrieve
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ Call
+ successful
+
+ Examples
+ --------
+ from intercom import Intercom
+
+ client = Intercom(
+ token="YOUR_TOKEN",
+ )
+ client.unstable.calls.show_call(
+ id="id",
+ )
+ """
+ _response = self._raw_client.show_call(id, request_options=request_options)
+ return _response.data
+
+ def show_call_recording(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+ """
+ Redirects to a signed URL for the call's recording if it exists.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ None
+
+ Examples
+ --------
+ from intercom import Intercom
+
+ client = Intercom(
+ token="YOUR_TOKEN",
+ )
+ client.unstable.calls.show_call_recording(
+ id="id",
+ )
+ """
+ _response = self._raw_client.show_call_recording(id, request_options=request_options)
+ return _response.data
+
+ def show_call_transcript(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> str:
+ """
+ Returns the transcript for the specified call as a downloadable text file.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ str
+ successful
+
+ Examples
+ --------
+ from intercom import Intercom
+
+ client = Intercom(
+ token="YOUR_TOKEN",
+ )
+ client.unstable.calls.show_call_transcript(
+ id="id",
+ )
+ """
+ _response = self._raw_client.show_call_transcript(id, request_options=request_options)
+ return _response.data
+
+ def list_calls_with_transcripts(
+ self, *, conversation_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None
+ ) -> ListCallsWithTranscriptsResponse:
+ """
+ Retrieve calls by a list of conversation ids and include transcripts when available.
+ A maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned.
+
+ Parameters
+ ----------
+ conversation_ids : typing.Sequence[str]
+ A list of conversation ids to fetch calls for. Maximum 20.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ ListCallsWithTranscriptsResponse
+ successful
+
+ Examples
+ --------
+ from intercom import Intercom
+
+ client = Intercom(
+ token="YOUR_TOKEN",
+ )
+ client.unstable.calls.list_calls_with_transcripts(
+ conversation_ids=["64619700005694", "64619700005695"],
+ )
+ """
+ _response = self._raw_client.list_calls_with_transcripts(
+ conversation_ids=conversation_ids, request_options=request_options
+ )
+ return _response.data
+
+
+class AsyncCallsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._raw_client = AsyncRawCallsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> AsyncRawCallsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ AsyncRawCallsClient
+ """
+ return self._raw_client
+
+ async def list_calls(
+ self,
+ *,
+ page: typing.Optional[int] = None,
+ per_page: typing.Optional[int] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> CallList:
+ """
+ Retrieve a paginated list of calls.
+
+ Parameters
+ ----------
+ page : typing.Optional[int]
+ The page of results to fetch. Defaults to first page
+
+ per_page : typing.Optional[int]
+ How many results to display per page. Defaults to 25. Max 25.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ CallList
+ successful
+
+ Examples
+ --------
+ import asyncio
+
+ from intercom import AsyncIntercom
+
+ client = AsyncIntercom(
+ token="YOUR_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.unstable.calls.list_calls()
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.list_calls(page=page, per_page=per_page, request_options=request_options)
+ return _response.data
+
+ async def show_call(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Call:
+ """
+ Retrieve a single call by id.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call to retrieve
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ Call
+ successful
+
+ Examples
+ --------
+ import asyncio
+
+ from intercom import AsyncIntercom
+
+ client = AsyncIntercom(
+ token="YOUR_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.unstable.calls.show_call(
+ id="id",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.show_call(id, request_options=request_options)
+ return _response.data
+
+ async def show_call_recording(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+ """
+ Redirects to a signed URL for the call's recording if it exists.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ None
+
+ Examples
+ --------
+ import asyncio
+
+ from intercom import AsyncIntercom
+
+ client = AsyncIntercom(
+ token="YOUR_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.unstable.calls.show_call_recording(
+ id="id",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.show_call_recording(id, request_options=request_options)
+ return _response.data
+
+ async def show_call_transcript(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> str:
+ """
+ Returns the transcript for the specified call as a downloadable text file.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ str
+ successful
+
+ Examples
+ --------
+ import asyncio
+
+ from intercom import AsyncIntercom
+
+ client = AsyncIntercom(
+ token="YOUR_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.unstable.calls.show_call_transcript(
+ id="id",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.show_call_transcript(id, request_options=request_options)
+ return _response.data
+
+ async def list_calls_with_transcripts(
+ self, *, conversation_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None
+ ) -> ListCallsWithTranscriptsResponse:
+ """
+ Retrieve calls by a list of conversation ids and include transcripts when available.
+ A maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned.
+
+ Parameters
+ ----------
+ conversation_ids : typing.Sequence[str]
+ A list of conversation ids to fetch calls for. Maximum 20.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ ListCallsWithTranscriptsResponse
+ successful
+
+ Examples
+ --------
+ import asyncio
+
+ from intercom import AsyncIntercom
+
+ client = AsyncIntercom(
+ token="YOUR_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.unstable.calls.list_calls_with_transcripts(
+ conversation_ids=["64619700005694", "64619700005695"],
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.list_calls_with_transcripts(
+ conversation_ids=conversation_ids, request_options=request_options
+ )
+ return _response.data
diff --git a/src/intercom/unstable/calls/raw_client.py b/src/intercom/unstable/calls/raw_client.py
new file mode 100644
index 0000000..bff6748
--- /dev/null
+++ b/src/intercom/unstable/calls/raw_client.py
@@ -0,0 +1,603 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.jsonable_encoder import jsonable_encoder
+from ...core.request_options import RequestOptions
+from ...core.unchecked_base_model import construct_type
+from ..errors.bad_request_error import BadRequestError
+from ..errors.not_found_error import NotFoundError
+from ..errors.unauthorized_error import UnauthorizedError
+from ..types.call_list import CallList
+from ..types.error import Error
+from .types.call import Call
+from .types.list_calls_with_transcripts_response import ListCallsWithTranscriptsResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawCallsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ def list_calls(
+ self,
+ *,
+ page: typing.Optional[int] = None,
+ per_page: typing.Optional[int] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[CallList]:
+ """
+ Retrieve a paginated list of calls.
+
+ Parameters
+ ----------
+ page : typing.Optional[int]
+ The page of results to fetch. Defaults to first page
+
+ per_page : typing.Optional[int]
+ How many results to display per page. Defaults to 25. Max 25.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[CallList]
+ successful
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ "calls",
+ method="GET",
+ params={
+ "page": page,
+ "per_page": per_page,
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ CallList,
+ construct_type(
+ type_=CallList, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def show_call(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Call]:
+ """
+ Retrieve a single call by id.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call to retrieve
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[Call]
+ successful
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"calls/{jsonable_encoder(id)}",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ Call,
+ construct_type(
+ type_=Call, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def show_call_recording(
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[None]:
+ """
+ Redirects to a signed URL for the call's recording if it exists.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[None]
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"calls/{jsonable_encoder(id)}/recording",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ return HttpResponse(response=_response, data=None)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def show_call_transcript(
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[str]:
+ """
+ Returns the transcript for the specified call as a downloadable text file.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[str]
+ successful
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"calls/{jsonable_encoder(id)}/transcript",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ return HttpResponse(response=_response, data=_response.text) # type: ignore
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def list_calls_with_transcripts(
+ self, *, conversation_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[ListCallsWithTranscriptsResponse]:
+ """
+ Retrieve calls by a list of conversation ids and include transcripts when available.
+ A maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned.
+
+ Parameters
+ ----------
+ conversation_ids : typing.Sequence[str]
+ A list of conversation ids to fetch calls for. Maximum 20.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[ListCallsWithTranscriptsResponse]
+ successful
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ "calls/search",
+ method="POST",
+ json={
+ "conversation_ids": conversation_ids,
+ },
+ headers={
+ "content-type": "application/json",
+ },
+ request_options=request_options,
+ omit=OMIT,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ ListCallsWithTranscriptsResponse,
+ construct_type(
+ type_=ListCallsWithTranscriptsResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawCallsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ async def list_calls(
+ self,
+ *,
+ page: typing.Optional[int] = None,
+ per_page: typing.Optional[int] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[CallList]:
+ """
+ Retrieve a paginated list of calls.
+
+ Parameters
+ ----------
+ page : typing.Optional[int]
+ The page of results to fetch. Defaults to first page
+
+ per_page : typing.Optional[int]
+ How many results to display per page. Defaults to 25. Max 25.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[CallList]
+ successful
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ "calls",
+ method="GET",
+ params={
+ "page": page,
+ "per_page": per_page,
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ CallList,
+ construct_type(
+ type_=CallList, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def show_call(
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[Call]:
+ """
+ Retrieve a single call by id.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call to retrieve
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[Call]
+ successful
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"calls/{jsonable_encoder(id)}",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ Call,
+ construct_type(
+ type_=Call, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def show_call_recording(
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[None]:
+ """
+ Redirects to a signed URL for the call's recording if it exists.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[None]
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"calls/{jsonable_encoder(id)}/recording",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ return AsyncHttpResponse(response=_response, data=None)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def show_call_transcript(
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[str]:
+ """
+ Returns the transcript for the specified call as a downloadable text file.
+
+ Parameters
+ ----------
+ id : str
+ The id of the call
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[str]
+ successful
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"calls/{jsonable_encoder(id)}/transcript",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ return AsyncHttpResponse(response=_response, data=_response.text) # type: ignore
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def list_calls_with_transcripts(
+ self, *, conversation_ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[ListCallsWithTranscriptsResponse]:
+ """
+ Retrieve calls by a list of conversation ids and include transcripts when available.
+ A maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned.
+
+ Parameters
+ ----------
+ conversation_ids : typing.Sequence[str]
+ A list of conversation ids to fetch calls for. Maximum 20.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[ListCallsWithTranscriptsResponse]
+ successful
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ "calls/search",
+ method="POST",
+ json={
+ "conversation_ids": conversation_ids,
+ },
+ headers={
+ "content-type": "application/json",
+ },
+ request_options=request_options,
+ omit=OMIT,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ ListCallsWithTranscriptsResponse,
+ construct_type(
+ type_=ListCallsWithTranscriptsResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
diff --git a/src/intercom/unstable/calls/types/__init__.py b/src/intercom/unstable/calls/types/__init__.py
new file mode 100644
index 0000000..f0f25e4
--- /dev/null
+++ b/src/intercom/unstable/calls/types/__init__.py
@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .call import Call
+from .list_calls_with_transcripts_response import ListCallsWithTranscriptsResponse
+from .list_calls_with_transcripts_response_data_item import ListCallsWithTranscriptsResponseDataItem
+
+__all__ = ["Call", "ListCallsWithTranscriptsResponse", "ListCallsWithTranscriptsResponseDataItem"]
diff --git a/src/intercom/unstable/calls/types/call.py b/src/intercom/unstable/calls/types/call.py
new file mode 100644
index 0000000..30cc9df
--- /dev/null
+++ b/src/intercom/unstable/calls/types/call.py
@@ -0,0 +1,93 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from ...types.datetime import Datetime
+
+
+class Call(UncheckedBaseModel):
+ """
+ Represents a phone call in Intercom
+ """
+
+ type: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ String representing the object's type. Always has the value `call`.
+ """
+
+ id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The id of the call.
+ """
+
+ conversation_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The id of the conversation associated with the call, if any.
+ """
+
+ admin_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The id of the admin associated with the call, if any.
+ """
+
+ contact_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The id of the contact associated with the call, if any.
+ """
+
+ state: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The current state of the call.
+ """
+
+ initiated_at: typing.Optional[Datetime] = None
+ answered_at: typing.Optional[Datetime] = None
+ ended_at: typing.Optional[Datetime] = None
+ created_at: typing.Optional[Datetime] = None
+ updated_at: typing.Optional[Datetime] = None
+ recording_url: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ API URL to download or redirect to the call recording if available.
+ """
+
+ call_type: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The type of call.
+ """
+
+ direction: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The direction of the call.
+ """
+
+ ended_reason: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The reason for the call end, if applicable.
+ """
+
+ phone: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The phone number involved in the call, in E.164 format.
+ """
+
+ fin_recording_url: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ API URL to the AI Agent (Fin) call recording if available.
+ """
+
+ fin_transcription_url: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ API URL to the AI Agent (Fin) call transcript if available.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/unstable/calls/types/list_calls_with_transcripts_response.py b/src/intercom/unstable/calls/types/list_calls_with_transcripts_response.py
new file mode 100644
index 0000000..840f91b
--- /dev/null
+++ b/src/intercom/unstable/calls/types/list_calls_with_transcripts_response.py
@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .list_calls_with_transcripts_response_data_item import ListCallsWithTranscriptsResponseDataItem
+
+
+class ListCallsWithTranscriptsResponse(UncheckedBaseModel):
+ type: typing.Optional[str] = None
+ data: typing.Optional[typing.List[ListCallsWithTranscriptsResponseDataItem]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/unstable/calls/types/list_calls_with_transcripts_response_data_item.py b/src/intercom/unstable/calls/types/list_calls_with_transcripts_response_data_item.py
new file mode 100644
index 0000000..4994f3f
--- /dev/null
+++ b/src/intercom/unstable/calls/types/list_calls_with_transcripts_response_data_item.py
@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from .call import Call
+
+
+class ListCallsWithTranscriptsResponseDataItem(Call):
+ transcript: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(
+ default=None
+ )
+ """
+ The call transcript if available, otherwise an empty array.
+ """
+
+ transcript_status: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The status of the transcript if available.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/unstable/client.py b/src/intercom/unstable/client.py
index 97e8e34..edcf480 100644
--- a/src/intercom/unstable/client.py
+++ b/src/intercom/unstable/client.py
@@ -5,6 +5,8 @@
from .ai_content.client import AiContentClient, AsyncAiContentClient
from .articles.client import ArticlesClient, AsyncArticlesClient
from .away_status_reasons.client import AsyncAwayStatusReasonsClient, AwayStatusReasonsClient
+from .brands.client import AsyncBrandsClient, BrandsClient
+from .calls.client import AsyncCallsClient, CallsClient
from .companies.client import AsyncCompaniesClient, CompaniesClient
from .contacts.client import AsyncContactsClient, ContactsClient
from .conversations.client import AsyncConversationsClient, ConversationsClient
@@ -13,9 +15,12 @@
from .data_attributes.client import AsyncDataAttributesClient, DataAttributesClient
from .data_events.client import AsyncDataEventsClient, DataEventsClient
from .data_export.client import AsyncDataExportClient, DataExportClient
+from .emails.client import AsyncEmailsClient, EmailsClient
from .export.client import AsyncExportClient, ExportClient
from .help_center.client import AsyncHelpCenterClient, HelpCenterClient
+from .internal_articles.client import AsyncInternalArticlesClient, InternalArticlesClient
from .jobs.client import AsyncJobsClient, JobsClient
+from .macros.client import AsyncMacrosClient, MacrosClient
from .messages.client import AsyncMessagesClient, MessagesClient
from .news.client import AsyncNewsClient, NewsClient
from .notes.client import AsyncNotesClient, NotesClient
@@ -47,6 +52,8 @@ def __init__(self, *, client_wrapper: SyncClientWrapper):
self.help_center = HelpCenterClient(client_wrapper=client_wrapper)
+ self.internal_articles = InternalArticlesClient(client_wrapper=client_wrapper)
+
self.companies = CompaniesClient(client_wrapper=client_wrapper)
self.contacts = ContactsClient(client_wrapper=client_wrapper)
@@ -71,6 +78,8 @@ def __init__(self, *, client_wrapper: SyncClientWrapper):
self.jobs = JobsClient(client_wrapper=client_wrapper)
+ self.macros = MacrosClient(client_wrapper=client_wrapper)
+
self.messages = MessagesClient(client_wrapper=client_wrapper)
self.news = NewsClient(client_wrapper=client_wrapper)
@@ -79,6 +88,8 @@ def __init__(self, *, client_wrapper: SyncClientWrapper):
self.switch = SwitchClient(client_wrapper=client_wrapper)
+ self.calls = CallsClient(client_wrapper=client_wrapper)
+
self.teams = TeamsClient(client_wrapper=client_wrapper)
self.ticket_states = TicketStatesClient(client_wrapper=client_wrapper)
@@ -91,6 +102,10 @@ def __init__(self, *, client_wrapper: SyncClientWrapper):
self.visitors = VisitorsClient(client_wrapper=client_wrapper)
+ self.brands = BrandsClient(client_wrapper=client_wrapper)
+
+ self.emails = EmailsClient(client_wrapper=client_wrapper)
+
@property
def with_raw_response(self) -> RawUnstableClient:
"""
@@ -118,6 +133,8 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper):
self.help_center = AsyncHelpCenterClient(client_wrapper=client_wrapper)
+ self.internal_articles = AsyncInternalArticlesClient(client_wrapper=client_wrapper)
+
self.companies = AsyncCompaniesClient(client_wrapper=client_wrapper)
self.contacts = AsyncContactsClient(client_wrapper=client_wrapper)
@@ -142,6 +159,8 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper):
self.jobs = AsyncJobsClient(client_wrapper=client_wrapper)
+ self.macros = AsyncMacrosClient(client_wrapper=client_wrapper)
+
self.messages = AsyncMessagesClient(client_wrapper=client_wrapper)
self.news = AsyncNewsClient(client_wrapper=client_wrapper)
@@ -150,6 +169,8 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper):
self.switch = AsyncSwitchClient(client_wrapper=client_wrapper)
+ self.calls = AsyncCallsClient(client_wrapper=client_wrapper)
+
self.teams = AsyncTeamsClient(client_wrapper=client_wrapper)
self.ticket_states = AsyncTicketStatesClient(client_wrapper=client_wrapper)
@@ -162,6 +183,10 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper):
self.visitors = AsyncVisitorsClient(client_wrapper=client_wrapper)
+ self.brands = AsyncBrandsClient(client_wrapper=client_wrapper)
+
+ self.emails = AsyncEmailsClient(client_wrapper=client_wrapper)
+
@property
def with_raw_response(self) -> AsyncRawUnstableClient:
"""
diff --git a/src/intercom/unstable/conversations/client.py b/src/intercom/unstable/conversations/client.py
index 793fb32..30c409c 100644
--- a/src/intercom/unstable/conversations/client.py
+++ b/src/intercom/unstable/conversations/client.py
@@ -148,6 +148,7 @@ def retrieve_conversation(
id: int,
*,
display_as: typing.Optional[str] = None,
+ include_translations: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> Conversation:
"""
@@ -170,6 +171,9 @@ def retrieve_conversation(
display_as : typing.Optional[str]
Set to plaintext to retrieve conversation messages in plain text.
+ include_translations : typing.Optional[bool]
+ If set to true, conversation parts will be translated to the detected language of the conversation.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -190,7 +194,9 @@ def retrieve_conversation(
display_as="plaintext",
)
"""
- _response = self._raw_client.retrieve_conversation(id, display_as=display_as, request_options=request_options)
+ _response = self._raw_client.retrieve_conversation(
+ id, display_as=display_as, include_translations=include_translations, request_options=request_options
+ )
return _response.data
def update_conversation(
@@ -881,6 +887,7 @@ async def retrieve_conversation(
id: int,
*,
display_as: typing.Optional[str] = None,
+ include_translations: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> Conversation:
"""
@@ -903,6 +910,9 @@ async def retrieve_conversation(
display_as : typing.Optional[str]
Set to plaintext to retrieve conversation messages in plain text.
+ include_translations : typing.Optional[bool]
+ If set to true, conversation parts will be translated to the detected language of the conversation.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -932,7 +942,7 @@ async def main() -> None:
asyncio.run(main())
"""
_response = await self._raw_client.retrieve_conversation(
- id, display_as=display_as, request_options=request_options
+ id, display_as=display_as, include_translations=include_translations, request_options=request_options
)
return _response.data
diff --git a/src/intercom/unstable/conversations/raw_client.py b/src/intercom/unstable/conversations/raw_client.py
index 5c4343a..1c00622 100644
--- a/src/intercom/unstable/conversations/raw_client.py
+++ b/src/intercom/unstable/conversations/raw_client.py
@@ -223,6 +223,7 @@ def retrieve_conversation(
id: int,
*,
display_as: typing.Optional[str] = None,
+ include_translations: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Conversation]:
"""
@@ -245,6 +246,9 @@ def retrieve_conversation(
display_as : typing.Optional[str]
Set to plaintext to retrieve conversation messages in plain text.
+ include_translations : typing.Optional[bool]
+ If set to true, conversation parts will be translated to the detected language of the conversation.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -258,6 +262,7 @@ def retrieve_conversation(
method="GET",
params={
"display_as": display_as,
+ "include_translations": include_translations,
},
request_options=request_options,
)
@@ -1347,6 +1352,7 @@ async def retrieve_conversation(
id: int,
*,
display_as: typing.Optional[str] = None,
+ include_translations: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Conversation]:
"""
@@ -1369,6 +1375,9 @@ async def retrieve_conversation(
display_as : typing.Optional[str]
Set to plaintext to retrieve conversation messages in plain text.
+ include_translations : typing.Optional[bool]
+ If set to true, conversation parts will be translated to the detected language of the conversation.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -1382,6 +1391,7 @@ async def retrieve_conversation(
method="GET",
params={
"display_as": display_as,
+ "include_translations": include_translations,
},
request_options=request_options,
)
diff --git a/src/intercom/unstable/data_attributes/__init__.py b/src/intercom/unstable/data_attributes/__init__.py
index de4ec31..581c1dd 100644
--- a/src/intercom/unstable/data_attributes/__init__.py
+++ b/src/intercom/unstable/data_attributes/__init__.py
@@ -2,20 +2,6 @@
# isort: skip_file
-from .types import (
- CreateDataAttributeRequestDataType,
- CreateDataAttributeRequestModel,
- DataAttribute,
- DataAttributeDataType,
- DataAttributeModel,
- LisDataAttributesRequestModel,
-)
+from .types import DataAttribute, DataAttributeDataType, DataAttributeModel, LisDataAttributesRequestModel
-__all__ = [
- "CreateDataAttributeRequestDataType",
- "CreateDataAttributeRequestModel",
- "DataAttribute",
- "DataAttributeDataType",
- "DataAttributeModel",
- "LisDataAttributesRequestModel",
-]
+__all__ = ["DataAttribute", "DataAttributeDataType", "DataAttributeModel", "LisDataAttributesRequestModel"]
diff --git a/src/intercom/unstable/data_attributes/client.py b/src/intercom/unstable/data_attributes/client.py
index a97376e..c929202 100644
--- a/src/intercom/unstable/data_attributes/client.py
+++ b/src/intercom/unstable/data_attributes/client.py
@@ -6,8 +6,6 @@
from ...core.request_options import RequestOptions
from ..types.data_attribute_list import DataAttributeList
from .raw_client import AsyncRawDataAttributesClient, RawDataAttributesClient
-from .types.create_data_attribute_request_data_type import CreateDataAttributeRequestDataType
-from .types.create_data_attribute_request_model import CreateDataAttributeRequestModel
from .types.data_attribute import DataAttribute
from .types.lis_data_attributes_request_model import LisDataAttributesRequestModel
@@ -71,38 +69,14 @@ def lis_data_attributes(
return _response.data
def create_data_attribute(
- self,
- *,
- name: str,
- model: CreateDataAttributeRequestModel,
- data_type: CreateDataAttributeRequestDataType,
- description: typing.Optional[str] = OMIT,
- options: typing.Optional[typing.Sequence[str]] = OMIT,
- messenger_writable: typing.Optional[bool] = OMIT,
- request_options: typing.Optional[RequestOptions] = None,
+ self, *, request: typing.Optional[typing.Any] = None, request_options: typing.Optional[RequestOptions] = None
) -> DataAttribute:
"""
You can create a data attributes for a `contact` or a `company`.
Parameters
----------
- name : str
- The name of the data attribute.
-
- model : CreateDataAttributeRequestModel
- The model that the data attribute belongs to.
-
- data_type : CreateDataAttributeRequestDataType
- The type of data stored for this attribute.
-
- description : typing.Optional[str]
- The readable description you see in the UI for the attribute.
-
- options : typing.Optional[typing.Sequence[str]]
- 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`.
-
- messenger_writable : typing.Optional[bool]
- Can this attribute be updated by the Messenger
+ request : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -120,30 +94,17 @@ def create_data_attribute(
token="YOUR_TOKEN",
)
client.unstable.data_attributes.create_data_attribute(
- name="Mithril Shirt",
- model="company",
- data_type="string",
+ request={"key": "value"},
)
"""
- _response = self._raw_client.create_data_attribute(
- name=name,
- model=model,
- data_type=data_type,
- description=description,
- options=options,
- messenger_writable=messenger_writable,
- request_options=request_options,
- )
+ _response = self._raw_client.create_data_attribute(request=request, request_options=request_options)
return _response.data
def update_data_attribute(
self,
id: int,
*,
- archived: typing.Optional[bool] = OMIT,
- description: typing.Optional[str] = OMIT,
- options: typing.Optional[typing.Sequence[str]] = OMIT,
- messenger_writable: typing.Optional[bool] = OMIT,
+ request: typing.Optional[typing.Any] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> DataAttribute:
"""
@@ -159,17 +120,7 @@ def update_data_attribute(
id : int
The data attribute id
- archived : typing.Optional[bool]
- Whether the attribute is to be archived or not.
-
- description : typing.Optional[str]
- The readable description you see in the UI for the attribute.
-
- options : typing.Optional[typing.Sequence[str]]
- 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`.
-
- messenger_writable : typing.Optional[bool]
- Can this attribute be updated by the Messenger
+ request : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -188,19 +139,10 @@ def update_data_attribute(
)
client.unstable.data_attributes.update_data_attribute(
id=1,
- archived=False,
- description="Just a plain old ring",
- options=["options", "options"],
+ request={"key": "value"},
)
"""
- _response = self._raw_client.update_data_attribute(
- id,
- archived=archived,
- description=description,
- options=options,
- messenger_writable=messenger_writable,
- request_options=request_options,
- )
+ _response = self._raw_client.update_data_attribute(id, request=request, request_options=request_options)
return _response.data
@@ -268,38 +210,14 @@ async def main() -> None:
return _response.data
async def create_data_attribute(
- self,
- *,
- name: str,
- model: CreateDataAttributeRequestModel,
- data_type: CreateDataAttributeRequestDataType,
- description: typing.Optional[str] = OMIT,
- options: typing.Optional[typing.Sequence[str]] = OMIT,
- messenger_writable: typing.Optional[bool] = OMIT,
- request_options: typing.Optional[RequestOptions] = None,
+ self, *, request: typing.Optional[typing.Any] = None, request_options: typing.Optional[RequestOptions] = None
) -> DataAttribute:
"""
You can create a data attributes for a `contact` or a `company`.
Parameters
----------
- name : str
- The name of the data attribute.
-
- model : CreateDataAttributeRequestModel
- The model that the data attribute belongs to.
-
- data_type : CreateDataAttributeRequestDataType
- The type of data stored for this attribute.
-
- description : typing.Optional[str]
- The readable description you see in the UI for the attribute.
-
- options : typing.Optional[typing.Sequence[str]]
- 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`.
-
- messenger_writable : typing.Optional[bool]
- Can this attribute be updated by the Messenger
+ request : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -322,33 +240,20 @@ async def create_data_attribute(
async def main() -> None:
await client.unstable.data_attributes.create_data_attribute(
- name="Mithril Shirt",
- model="company",
- data_type="string",
+ request={"key": "value"},
)
asyncio.run(main())
"""
- _response = await self._raw_client.create_data_attribute(
- name=name,
- model=model,
- data_type=data_type,
- description=description,
- options=options,
- messenger_writable=messenger_writable,
- request_options=request_options,
- )
+ _response = await self._raw_client.create_data_attribute(request=request, request_options=request_options)
return _response.data
async def update_data_attribute(
self,
id: int,
*,
- archived: typing.Optional[bool] = OMIT,
- description: typing.Optional[str] = OMIT,
- options: typing.Optional[typing.Sequence[str]] = OMIT,
- messenger_writable: typing.Optional[bool] = OMIT,
+ request: typing.Optional[typing.Any] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> DataAttribute:
"""
@@ -364,17 +269,7 @@ async def update_data_attribute(
id : int
The data attribute id
- archived : typing.Optional[bool]
- Whether the attribute is to be archived or not.
-
- description : typing.Optional[str]
- The readable description you see in the UI for the attribute.
-
- options : typing.Optional[typing.Sequence[str]]
- 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`.
-
- messenger_writable : typing.Optional[bool]
- Can this attribute be updated by the Messenger
+ request : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -398,20 +293,11 @@ async def update_data_attribute(
async def main() -> None:
await client.unstable.data_attributes.update_data_attribute(
id=1,
- archived=False,
- description="Just a plain old ring",
- options=["options", "options"],
+ request={"key": "value"},
)
asyncio.run(main())
"""
- _response = await self._raw_client.update_data_attribute(
- id,
- archived=archived,
- description=description,
- options=options,
- messenger_writable=messenger_writable,
- request_options=request_options,
- )
+ _response = await self._raw_client.update_data_attribute(id, request=request, request_options=request_options)
return _response.data
diff --git a/src/intercom/unstable/data_attributes/raw_client.py b/src/intercom/unstable/data_attributes/raw_client.py
index 8e33e37..ab43b41 100644
--- a/src/intercom/unstable/data_attributes/raw_client.py
+++ b/src/intercom/unstable/data_attributes/raw_client.py
@@ -15,8 +15,6 @@
from ..errors.unprocessable_entity_error import UnprocessableEntityError
from ..types.data_attribute_list import DataAttributeList
from ..types.error import Error
-from .types.create_data_attribute_request_data_type import CreateDataAttributeRequestDataType
-from .types.create_data_attribute_request_model import CreateDataAttributeRequestModel
from .types.data_attribute import DataAttribute
from .types.lis_data_attributes_request_model import LisDataAttributesRequestModel
@@ -90,38 +88,14 @@ def lis_data_attributes(
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
def create_data_attribute(
- self,
- *,
- name: str,
- model: CreateDataAttributeRequestModel,
- data_type: CreateDataAttributeRequestDataType,
- description: typing.Optional[str] = OMIT,
- options: typing.Optional[typing.Sequence[str]] = OMIT,
- messenger_writable: typing.Optional[bool] = OMIT,
- request_options: typing.Optional[RequestOptions] = None,
+ self, *, request: typing.Optional[typing.Any] = None, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[DataAttribute]:
"""
You can create a data attributes for a `contact` or a `company`.
Parameters
----------
- name : str
- The name of the data attribute.
-
- model : CreateDataAttributeRequestModel
- The model that the data attribute belongs to.
-
- data_type : CreateDataAttributeRequestDataType
- The type of data stored for this attribute.
-
- description : typing.Optional[str]
- The readable description you see in the UI for the attribute.
-
- options : typing.Optional[typing.Sequence[str]]
- 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`.
-
- messenger_writable : typing.Optional[bool]
- Can this attribute be updated by the Messenger
+ request : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -134,14 +108,7 @@ def create_data_attribute(
_response = self._client_wrapper.httpx_client.request(
"data_attributes",
method="POST",
- json={
- "name": name,
- "model": model,
- "data_type": data_type,
- "description": description,
- "options": options,
- "messenger_writable": messenger_writable,
- },
+ json=request,
headers={
"content-type": "application/json",
},
@@ -189,10 +156,7 @@ def update_data_attribute(
self,
id: int,
*,
- archived: typing.Optional[bool] = OMIT,
- description: typing.Optional[str] = OMIT,
- options: typing.Optional[typing.Sequence[str]] = OMIT,
- messenger_writable: typing.Optional[bool] = OMIT,
+ request: typing.Optional[typing.Any] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[DataAttribute]:
"""
@@ -208,17 +172,7 @@ def update_data_attribute(
id : int
The data attribute id
- archived : typing.Optional[bool]
- Whether the attribute is to be archived or not.
-
- description : typing.Optional[str]
- The readable description you see in the UI for the attribute.
-
- options : typing.Optional[typing.Sequence[str]]
- 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`.
-
- messenger_writable : typing.Optional[bool]
- Can this attribute be updated by the Messenger
+ request : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -231,12 +185,7 @@ def update_data_attribute(
_response = self._client_wrapper.httpx_client.request(
f"data_attributes/{jsonable_encoder(id)}",
method="PUT",
- json={
- "archived": archived,
- "description": description,
- "options": options,
- "messenger_writable": messenger_writable,
- },
+ json=request,
headers={
"content-type": "application/json",
},
@@ -369,38 +318,14 @@ async def lis_data_attributes(
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
async def create_data_attribute(
- self,
- *,
- name: str,
- model: CreateDataAttributeRequestModel,
- data_type: CreateDataAttributeRequestDataType,
- description: typing.Optional[str] = OMIT,
- options: typing.Optional[typing.Sequence[str]] = OMIT,
- messenger_writable: typing.Optional[bool] = OMIT,
- request_options: typing.Optional[RequestOptions] = None,
+ self, *, request: typing.Optional[typing.Any] = None, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[DataAttribute]:
"""
You can create a data attributes for a `contact` or a `company`.
Parameters
----------
- name : str
- The name of the data attribute.
-
- model : CreateDataAttributeRequestModel
- The model that the data attribute belongs to.
-
- data_type : CreateDataAttributeRequestDataType
- The type of data stored for this attribute.
-
- description : typing.Optional[str]
- The readable description you see in the UI for the attribute.
-
- options : typing.Optional[typing.Sequence[str]]
- 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`.
-
- messenger_writable : typing.Optional[bool]
- Can this attribute be updated by the Messenger
+ request : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -413,14 +338,7 @@ async def create_data_attribute(
_response = await self._client_wrapper.httpx_client.request(
"data_attributes",
method="POST",
- json={
- "name": name,
- "model": model,
- "data_type": data_type,
- "description": description,
- "options": options,
- "messenger_writable": messenger_writable,
- },
+ json=request,
headers={
"content-type": "application/json",
},
@@ -468,10 +386,7 @@ async def update_data_attribute(
self,
id: int,
*,
- archived: typing.Optional[bool] = OMIT,
- description: typing.Optional[str] = OMIT,
- options: typing.Optional[typing.Sequence[str]] = OMIT,
- messenger_writable: typing.Optional[bool] = OMIT,
+ request: typing.Optional[typing.Any] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[DataAttribute]:
"""
@@ -487,17 +402,7 @@ async def update_data_attribute(
id : int
The data attribute id
- archived : typing.Optional[bool]
- Whether the attribute is to be archived or not.
-
- description : typing.Optional[str]
- The readable description you see in the UI for the attribute.
-
- options : typing.Optional[typing.Sequence[str]]
- 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`.
-
- messenger_writable : typing.Optional[bool]
- Can this attribute be updated by the Messenger
+ request : typing.Optional[typing.Any]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -510,12 +415,7 @@ async def update_data_attribute(
_response = await self._client_wrapper.httpx_client.request(
f"data_attributes/{jsonable_encoder(id)}",
method="PUT",
- json={
- "archived": archived,
- "description": description,
- "options": options,
- "messenger_writable": messenger_writable,
- },
+ json=request,
headers={
"content-type": "application/json",
},
diff --git a/src/intercom/unstable/data_attributes/types/__init__.py b/src/intercom/unstable/data_attributes/types/__init__.py
index 2f1a58f..0764e89 100644
--- a/src/intercom/unstable/data_attributes/types/__init__.py
+++ b/src/intercom/unstable/data_attributes/types/__init__.py
@@ -2,18 +2,9 @@
# isort: skip_file
-from .create_data_attribute_request_data_type import CreateDataAttributeRequestDataType
-from .create_data_attribute_request_model import CreateDataAttributeRequestModel
from .data_attribute import DataAttribute
from .data_attribute_data_type import DataAttributeDataType
from .data_attribute_model import DataAttributeModel
from .lis_data_attributes_request_model import LisDataAttributesRequestModel
-__all__ = [
- "CreateDataAttributeRequestDataType",
- "CreateDataAttributeRequestModel",
- "DataAttribute",
- "DataAttributeDataType",
- "DataAttributeModel",
- "LisDataAttributesRequestModel",
-]
+__all__ = ["DataAttribute", "DataAttributeDataType", "DataAttributeModel", "LisDataAttributesRequestModel"]
diff --git a/src/intercom/unstable/data_attributes/types/create_data_attribute_request_model.py b/src/intercom/unstable/data_attributes/types/create_data_attribute_request_model.py
deleted file mode 100644
index cc5c9b6..0000000
--- a/src/intercom/unstable/data_attributes/types/create_data_attribute_request_model.py
+++ /dev/null
@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-CreateDataAttributeRequestModel = typing.Union[typing.Literal["contact", "company"], typing.Any]
diff --git a/src/intercom/unstable/emails/__init__.py b/src/intercom/unstable/emails/__init__.py
new file mode 100644
index 0000000..adc1484
--- /dev/null
+++ b/src/intercom/unstable/emails/__init__.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import EmailList, EmailSetting
+
+__all__ = ["EmailList", "EmailSetting"]
diff --git a/src/intercom/unstable/emails/client.py b/src/intercom/unstable/emails/client.py
new file mode 100644
index 0000000..cbcb564
--- /dev/null
+++ b/src/intercom/unstable/emails/client.py
@@ -0,0 +1,171 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from .raw_client import AsyncRawEmailsClient, RawEmailsClient
+from .types.email_list import EmailList
+from .types.email_setting import EmailSetting
+
+
+class EmailsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._raw_client = RawEmailsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> RawEmailsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ RawEmailsClient
+ """
+ return self._raw_client
+
+ def list_emails(self, *, request_options: typing.Optional[RequestOptions] = None) -> EmailList:
+ """
+ Lists all sender email address settings for the workspace
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ EmailList
+ Successful response
+
+ Examples
+ --------
+ from intercom import Intercom
+
+ client = Intercom(
+ token="YOUR_TOKEN",
+ )
+ client.unstable.emails.list_emails()
+ """
+ _response = self._raw_client.list_emails(request_options=request_options)
+ return _response.data
+
+ def retrieve_email(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> EmailSetting:
+ """
+ Fetches a specific email setting by its unique identifier
+
+ Parameters
+ ----------
+ id : str
+ The unique identifier of the email setting
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ EmailSetting
+ Successful response
+
+ Examples
+ --------
+ from intercom import Intercom
+
+ client = Intercom(
+ token="YOUR_TOKEN",
+ )
+ client.unstable.emails.retrieve_email(
+ id="id",
+ )
+ """
+ _response = self._raw_client.retrieve_email(id, request_options=request_options)
+ return _response.data
+
+
+class AsyncEmailsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._raw_client = AsyncRawEmailsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> AsyncRawEmailsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ AsyncRawEmailsClient
+ """
+ return self._raw_client
+
+ async def list_emails(self, *, request_options: typing.Optional[RequestOptions] = None) -> EmailList:
+ """
+ Lists all sender email address settings for the workspace
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ EmailList
+ Successful response
+
+ Examples
+ --------
+ import asyncio
+
+ from intercom import AsyncIntercom
+
+ client = AsyncIntercom(
+ token="YOUR_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.unstable.emails.list_emails()
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.list_emails(request_options=request_options)
+ return _response.data
+
+ async def retrieve_email(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> EmailSetting:
+ """
+ Fetches a specific email setting by its unique identifier
+
+ Parameters
+ ----------
+ id : str
+ The unique identifier of the email setting
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ EmailSetting
+ Successful response
+
+ Examples
+ --------
+ import asyncio
+
+ from intercom import AsyncIntercom
+
+ client = AsyncIntercom(
+ token="YOUR_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.unstable.emails.retrieve_email(
+ id="id",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.retrieve_email(id, request_options=request_options)
+ return _response.data
diff --git a/src/intercom/unstable/emails/raw_client.py b/src/intercom/unstable/emails/raw_client.py
new file mode 100644
index 0000000..6d26d00
--- /dev/null
+++ b/src/intercom/unstable/emails/raw_client.py
@@ -0,0 +1,240 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.jsonable_encoder import jsonable_encoder
+from ...core.request_options import RequestOptions
+from ...core.unchecked_base_model import construct_type
+from ..errors.not_found_error import NotFoundError
+from ..errors.unauthorized_error import UnauthorizedError
+from ..types.error import Error
+from .types.email_list import EmailList
+from .types.email_setting import EmailSetting
+
+
+class RawEmailsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ def list_emails(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[EmailList]:
+ """
+ Lists all sender email address settings for the workspace
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[EmailList]
+ Successful response
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ "emails",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ EmailList,
+ construct_type(
+ type_=EmailList, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def retrieve_email(
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[EmailSetting]:
+ """
+ Fetches a specific email setting by its unique identifier
+
+ Parameters
+ ----------
+ id : str
+ The unique identifier of the email setting
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[EmailSetting]
+ Successful response
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"emails/{jsonable_encoder(id)}",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ EmailSetting,
+ construct_type(
+ type_=EmailSetting, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawEmailsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ async def list_emails(
+ self, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[EmailList]:
+ """
+ Lists all sender email address settings for the workspace
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[EmailList]
+ Successful response
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ "emails",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ EmailList,
+ construct_type(
+ type_=EmailList, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def retrieve_email(
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[EmailSetting]:
+ """
+ Fetches a specific email setting by its unique identifier
+
+ Parameters
+ ----------
+ id : str
+ The unique identifier of the email setting
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[EmailSetting]
+ Successful response
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"emails/{jsonable_encoder(id)}",
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ EmailSetting,
+ construct_type(
+ type_=EmailSetting, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ construct_type(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Optional[typing.Any],
+ construct_type(
+ type_=typing.Optional[typing.Any], # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
diff --git a/src/intercom/unstable/emails/types/__init__.py b/src/intercom/unstable/emails/types/__init__.py
new file mode 100644
index 0000000..7c69dc2
--- /dev/null
+++ b/src/intercom/unstable/emails/types/__init__.py
@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .email_list import EmailList
+from .email_setting import EmailSetting
+
+__all__ = ["EmailList", "EmailSetting"]
diff --git a/src/intercom/unstable/emails/types/email_list.py b/src/intercom/unstable/emails/types/email_list.py
new file mode 100644
index 0000000..1547f3f
--- /dev/null
+++ b/src/intercom/unstable/emails/types/email_list.py
@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .email_setting import EmailSetting
+
+
+class EmailList(UncheckedBaseModel):
+ """
+ A list of email settings
+ """
+
+ type: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The type of object
+ """
+
+ data: typing.Optional[typing.List[EmailSetting]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/unstable/emails/types/email_setting.py b/src/intercom/unstable/emails/types/email_setting.py
new file mode 100644
index 0000000..09c11db
--- /dev/null
+++ b/src/intercom/unstable/emails/types/email_setting.py
@@ -0,0 +1,72 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class EmailSetting(UncheckedBaseModel):
+ """
+ Represents a sender email address configuration
+ """
+
+ type: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The type of object
+ """
+
+ id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Unique email setting identifier
+ """
+
+ email: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Full sender email address
+ """
+
+ verified: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Whether the email address has been verified
+ """
+
+ domain: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Domain portion of the email address
+ """
+
+ brand_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Associated brand identifier
+ """
+
+ forwarding_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Whether email forwarding is active
+ """
+
+ forwarded_email_last_received_at: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ Unix timestamp of last forwarded email received (null if never)
+ """
+
+ created_at: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ Unix timestamp of creation
+ """
+
+ updated_at: typing.Optional[int] = pydantic.Field(default=None)
+ """
+ Unix timestamp of last modification
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/intercom/unstable/export/client.py b/src/intercom/unstable/export/client.py
index 17a3049..a3b9cc8 100644
--- a/src/intercom/unstable/export/client.py
+++ b/src/intercom/unstable/export/client.py
@@ -64,10 +64,7 @@ def enqueue_a_new_reporting_data_export_job(
)
client.unstable.export.enqueue_a_new_reporting_data_export_job(
dataset_id="conversation",
- attribute_ids=[
- "conversation.id",
- "conversation.first_user_conversation_part_created_at",
- ],
+ attribute_ids=["conversation_id", "conversation_started_at"],
start_time=1717490000,
end_time=1717510000,
)
@@ -165,10 +162,7 @@ async def enqueue_a_new_reporting_data_export_job(
async def main() -> None:
await client.unstable.export.enqueue_a_new_reporting_data_export_job(
dataset_id="conversation",
- attribute_ids=[
- "conversation.id",
- "conversation.first_user_conversation_part_created_at",
- ],
+ attribute_ids=["conversation_id", "conversation_started_at"],
start_time=1717490000,
end_time=1717510000,
)
diff --git a/src/intercom/unstable/help_center/types/help_center.py b/src/intercom/unstable/help_center/types/help_center.py
index 0933074..93df1fb 100644
--- a/src/intercom/unstable/help_center/types/help_center.py
+++ b/src/intercom/unstable/help_center/types/help_center.py
@@ -47,6 +47,16 @@ class HelpCenter(UncheckedBaseModel):
The display name of the Help Center only seen by teammates.
"""
+ url: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.
+ """
+
+ custom_domain: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Custom domain configured for the help center
+ """
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/src/intercom/unstable/internal_articles/__init__.py b/src/intercom/unstable/internal_articles/__init__.py
new file mode 100644
index 0000000..7c622b6
--- /dev/null
+++ b/src/intercom/unstable/internal_articles/__init__.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import InternalArticleListItem, InternalArticleSearchResponse, InternalArticleSearchResponseData
+
+__all__ = ["InternalArticleListItem", "InternalArticleSearchResponse", "InternalArticleSearchResponseData"]
diff --git a/src/intercom/unstable/internal_articles/client.py b/src/intercom/unstable/internal_articles/client.py
new file mode 100644
index 0000000..7b1bf13
--- /dev/null
+++ b/src/intercom/unstable/internal_articles/client.py
@@ -0,0 +1,539 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ..articles.types.internal_article import InternalArticle
+from ..types.create_internal_article_request import CreateInternalArticleRequest
+from ..types.deleted_internal_article_object import DeletedInternalArticleObject
+from ..types.internal_article_list import InternalArticleList
+from .raw_client import AsyncRawInternalArticlesClient, RawInternalArticlesClient
+from .types.internal_article_search_response import InternalArticleSearchResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class InternalArticlesClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._raw_client = RawInternalArticlesClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> RawInternalArticlesClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ RawInternalArticlesClient
+ """
+ return self._raw_client
+
+ def list_internal_articles(self, *, request_options: typing.Optional[RequestOptions] = None) -> InternalArticleList:
+ """
+ You can fetch a list of all internal articles by making a GET request to `https://api.intercom.io/internal_articles`.
+
+ Parameters
+ ----------
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ InternalArticleList
+ successful
+
+ Examples
+ --------
+ from intercom import Intercom
+
+ client = Intercom(
+ token="YOUR_TOKEN",
+ )
+ client.unstable.internal_articles.list_internal_articles()
+ """
+ _response = self._raw_client.list_internal_articles(request_options=request_options)
+ return _response.data
+
+ def create_internal_article(
+ self,
+ *,
+ request: typing.Optional[CreateInternalArticleRequest] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> InternalArticle:
+ """
+ You can create a new internal article by making a POST request to `https://api.intercom.io/internal_articles`.
+
+ Parameters
+ ----------
+ request : typing.Optional[CreateInternalArticleRequest]
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ InternalArticle
+ internal article created
+
+ Examples
+ --------
+ from intercom import Intercom
+ from intercom.unstable import CreateInternalArticleRequest
+
+ client = Intercom(
+ token="YOUR_TOKEN",
+ )
+ client.unstable.internal_articles.create_internal_article(
+ request=CreateInternalArticleRequest(
+ title="Thanks for everything",
+ body="Body of the Article",
+ author_id=991266252,
+ owner_id=991266252,
+ ),
+ )
+ """
+ _response = self._raw_client.create_internal_article(request=request, request_options=request_options)
+ return _response.data
+
+ def retrieve_internal_article(
+ self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> InternalArticle:
+ """
+ You can fetch the details of a single internal article by making a GET request to `https://api.intercom.io/internal_articles/New gifts in store for the jolly season
", + ) + """ + _response = self._raw_client.update_internal_article( + id, title=title, body=body, author_id=author_id, owner_id=owner_id, request_options=request_options + ) + return _response.data + + def delete_internal_article( + self, id: int, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeletedInternalArticleObject: + """ + You can delete a single internal article by making a DELETE request to `https://api.intercom.io/internal_articles/New gifts in store for the jolly season
", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.update_internal_article( + id, title=title, body=body, author_id=author_id, owner_id=owner_id, request_options=request_options + ) + return _response.data + + async def delete_internal_article( + self, id: int, *, request_options: typing.Optional[RequestOptions] = None + ) -> DeletedInternalArticleObject: + """ + You can delete a single internal article by making a DELETE request to `https://api.intercom.io/internal_articles/