diff --git a/reference.md b/reference.md index 462ca43..88d56e2 100644 --- a/reference.md +++ b/reference.md @@ -1,6 +1,6 @@ # Reference ## Admins -
$client->admins->identify() -> ?AdminWithApp +
$client->admins->identify() -> ?AdminWithApp
@@ -44,7 +44,7 @@ $client->admins->identify();
-
$client->admins->away($request) -> ?Admin +
$client->admins->away($request) -> ?Admin
@@ -129,7 +129,7 @@ $client->admins->away(
-
$client->admins->listAllActivityLogs($request) -> ActivityLogList +
$client->admins->listAllActivityLogs($request) -> ActivityLogList
@@ -196,7 +196,7 @@ $client->admins->listAllActivityLogs(
-
$client->admins->list() -> AdminList +
$client->admins->list() -> AdminList
@@ -235,7 +235,7 @@ $client->admins->list();
-
$client->admins->find($request) -> ?Admin +
$client->admins->find($request) -> ?Admin
@@ -294,7 +294,7 @@ $client->admins->find(
## AI Content -
$client->aiContent->listContentImportSources() -> ContentImportSourcesList +
$client->aiContent->listContentImportSources() -> ContentImportSourcesList
@@ -333,7 +333,7 @@ $client->aiContent->listContentImportSources();
-
$client->aiContent->createContentImportSource($request) -> ContentImportSource +
$client->aiContent->createContentImportSource($request) -> ContentImportSource
@@ -408,7 +408,7 @@ $client->aiContent->createContentImportSource(
-
$client->aiContent->getContentImportSource($request) -> ContentImportSource +
$client->aiContent->getContentImportSource($request) -> ContentImportSource
@@ -452,7 +452,7 @@ $client->aiContent->getContentImportSource(
-
$client->aiContent->updateContentImportSource($request) -> ContentImportSource +
$client->aiContent->updateContentImportSource($request) -> ContentImportSource
@@ -536,7 +536,7 @@ $client->aiContent->updateContentImportSource(
-
$client->aiContent->deleteContentImportSource($request) +
$client->aiContent->deleteContentImportSource($request)
@@ -594,7 +594,7 @@ $client->aiContent->deleteContentImportSource(
-
$client->aiContent->listExternalPages() -> ExternalPagesList +
$client->aiContent->listExternalPages() -> ExternalPagesList
@@ -633,7 +633,7 @@ $client->aiContent->listExternalPages();
-
$client->aiContent->createExternalPage($request) -> ExternalPage +
$client->aiContent->createExternalPage($request) -> ExternalPage
@@ -752,7 +752,7 @@ $client->aiContent->createExternalPage(
-
$client->aiContent->getExternalPage($request) -> ExternalPage +
$client->aiContent->getExternalPage($request) -> ExternalPage
@@ -810,7 +810,7 @@ $client->aiContent->getExternalPage(
-
$client->aiContent->updateExternalPage($request) -> ExternalPage +
$client->aiContent->updateExternalPage($request) -> ExternalPage
@@ -930,7 +930,7 @@ $client->aiContent->updateExternalPage(
-
$client->aiContent->deleteExternalPage($request) -> ExternalPage +
$client->aiContent->deleteExternalPage($request) -> ExternalPage
@@ -989,7 +989,7 @@ $client->aiContent->deleteExternalPage(
## Articles -
$client->articles->list($request) -> ArticleList +
$client->articles->list($request) -> ArticleList
@@ -1057,7 +1057,7 @@ $client->articles->list(
-
$client->articles->create($request) -> Article +
$client->articles->create($request) -> Article
@@ -1130,7 +1130,7 @@ $client->articles->create(
-
$client->articles->find($request) -> Article +
$client->articles->find($request) -> Article
@@ -1188,7 +1188,7 @@ $client->articles->find(
-
$client->articles->update($request) -> Article +
$client->articles->update($request) -> Article
@@ -1312,7 +1312,7 @@ $client->articles->update(
-
$client->articles->delete($request) -> DeletedArticleObject +
$client->articles->delete($request) -> DeletedArticleObject
@@ -1370,7 +1370,7 @@ $client->articles->delete(
-
$client->articles->search($request) -> ArticleSearchResponse +
$client->articles->search($request) -> ArticleSearchResponse
@@ -1456,7 +1456,7 @@ $client->articles->search(
## Away Status Reasons -
$client->awayStatusReasons->listAwayStatusReasons() -> array +
$client->awayStatusReasons->listAwayStatusReasons() -> array
@@ -1496,7 +1496,7 @@ $client->awayStatusReasons->listAwayStatusReasons();
## Export -
$client->export->enqueueANewReportingDataExportJob($request) -> PostExportReportingDataEnqueueResponse +
$client->export->enqueueANewReportingDataExportJob($request) -> PostExportReportingDataEnqueueResponse
@@ -1570,7 +1570,7 @@ $client->export->enqueueANewReportingDataExportJob(
-
$client->export->listAvailableDatasetsAndAttributes() -> GetExportReportingDataGetDatasetsResponse +
$client->export->listAvailableDatasetsAndAttributes() -> GetExportReportingDataGetDatasetsResponse
@@ -1596,7 +1596,7 @@ $client->export->listAvailableDatasetsAndAttributes();
## Data Export -
$client->dataExport->exportReportingData($request) -> DataExportExportReportingDataResponse +
$client->dataExport->exportReportingData($request) -> DataExportExportReportingDataResponse
@@ -1658,7 +1658,7 @@ $client->dataExport->exportReportingData(
-
$client->dataExport->downloadReportingDataExport($request) +
$client->dataExport->downloadReportingDataExport($request)
@@ -1738,7 +1738,7 @@ $client->dataExport->downloadReportingDataExport(
-
$client->dataExport->create($request) -> DataExport +
$client->dataExport->create($request) -> DataExport
@@ -1819,7 +1819,7 @@ $client->dataExport->create(
-
$client->dataExport->find($request) -> DataExport +
$client->dataExport->find($request) -> DataExport
@@ -1881,7 +1881,7 @@ $client->dataExport->find(
-
$client->dataExport->cancel($request) -> DataExport +
$client->dataExport->cancel($request) -> DataExport
@@ -1939,7 +1939,7 @@ $client->dataExport->cancel(
-
$client->dataExport->download($request) +
$client->dataExport->download($request)
@@ -2004,7 +2004,7 @@ $client->dataExport->download(
## HelpCenters -
$client->helpCenters->find($request) -> HelpCenter +
$client->helpCenters->find($request) -> HelpCenter
@@ -2062,7 +2062,7 @@ $client->helpCenters->find(
-
$client->helpCenters->list($request) -> HelpCenterList +
$client->helpCenters->list($request) -> HelpCenterList
@@ -2127,7 +2127,7 @@ $client->helpCenters->list(
## Internal Articles -
$client->internalArticles->listInternalArticles() -> InternalArticleList +
$client->internalArticles->listInternalArticles() -> InternalArticleList
@@ -2166,7 +2166,7 @@ $client->internalArticles->listInternalArticles();
-
$client->internalArticles->createInternalArticle($request) -> InternalArticleListItem +
$client->internalArticles->createInternalArticle($request) -> InternalArticleListItem
@@ -2227,7 +2227,7 @@ $client->internalArticles->createInternalArticle(
-
$client->internalArticles->retrieveInternalArticle($request) -> InternalArticleListItem +
$client->internalArticles->retrieveInternalArticle($request) -> InternalArticleListItem
@@ -2285,7 +2285,7 @@ $client->internalArticles->retrieveInternalArticle(
-
$client->internalArticles->updateInternalArticle($request) -> InternalArticleListItem +
$client->internalArticles->updateInternalArticle($request) -> InternalArticleListItem
@@ -2377,7 +2377,7 @@ $client->internalArticles->updateInternalArticle(
-
$client->internalArticles->deleteInternalArticle($request) -> DeletedInternalArticleObject +
$client->internalArticles->deleteInternalArticle($request) -> DeletedInternalArticleObject
@@ -2435,7 +2435,7 @@ $client->internalArticles->deleteInternalArticle(
-
$client->internalArticles->searchInternalArticles($request) -> InternalArticleSearchResponse +
$client->internalArticles->searchInternalArticles($request) -> InternalArticleSearchResponse
@@ -2489,12 +2489,118 @@ $client->internalArticles->searchInternalArticles(
+ + +
+ +## IP Allowlist +
$client->ipAllowlist->getIpAllowlist() -> IpAllowlist +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve the current IP allowlist configuration for the workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```php +$client->ipAllowlist->getIpAllowlist(); +``` +
+
+
+
+ + +
+
+
+ +
$client->ipAllowlist->updateIpAllowlist($request) -> IpAllowlist +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update the IP allowlist configuration for the workspace. + +{% admonition type="warning" name="Lockout Protection" %} + The API will reject updates that would lock out the caller's IP address. Ensure your current IP is included in the allowlist when enabling the feature. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```php +$client->ipAllowlist->updateIpAllowlist( + new IpAllowlist([ + 'enabled' => true, + 'ipAllowlist' => [ + '192.168.1.0/24', + '10.0.0.1', + ], + ]), +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**$request:** `IpAllowlist` + +
+
+
+
+ +
## Companies -
$client->companies->retrieve($request) -> CompaniesRetrieveResponse +
$client->companies->retrieve($request) -> CompaniesRetrieveResponse
@@ -2607,7 +2713,7 @@ $client->companies->retrieve(
-
$client->companies->createOrUpdate($request) -> Company +
$client->companies->createOrUpdate($request) -> Company
@@ -2675,7 +2781,7 @@ $client->companies->createOrUpdate(
-
$client->companies->find($request) -> Company +
$client->companies->find($request) -> Company
@@ -2733,7 +2839,7 @@ $client->companies->find(
-
$client->companies->update($request) -> Company +
$client->companies->update($request) -> Company
@@ -2807,7 +2913,7 @@ $client->companies->update(
-
$client->companies->delete($request) -> DeletedCompanyObject +
$client->companies->delete($request) -> DeletedCompanyObject
@@ -2865,7 +2971,7 @@ $client->companies->delete(
-
$client->companies->listAttachedContacts($request) -> CompanyAttachedContacts +
$client->companies->listAttachedContacts($request) -> CompanyAttachedContacts
@@ -2923,7 +3029,7 @@ $client->companies->listAttachedContacts(
-
$client->companies->listAttachedSegments($request) -> CompanyAttachedSegments +
$client->companies->listAttachedSegments($request) -> CompanyAttachedSegments
@@ -2981,7 +3087,7 @@ $client->companies->listAttachedSegments(
-
$client->companies->list($request) -> CompanyList +
$client->companies->list($request) -> CompanyList
@@ -3065,7 +3171,7 @@ $client->companies->list(
-
$client->companies->scroll($request) -> ?CompanyScroll +
$client->companies->scroll($request) -> ?CompanyScroll
@@ -3137,7 +3243,7 @@ $client->companies->scroll(
-
$client->companies->attachContact($request) -> Company +
$client->companies->attachContact($request) -> Company
@@ -3204,7 +3310,7 @@ $client->companies->attachContact(
-
$client->companies->detachContact($request) -> Company +
$client->companies->detachContact($request) -> Company
@@ -3272,7 +3378,7 @@ $client->companies->detachContact(
## Contacts -
$client->contacts->listAttachedCompanies($request) -> ContactAttachedCompanies +
$client->contacts->listAttachedCompanies($request) -> ContactAttachedCompanies
@@ -3348,7 +3454,7 @@ $client->contacts->listAttachedCompanies(
-
$client->contacts->listAttachedSegments($request) -> ContactSegments +
$client->contacts->listAttachedSegments($request) -> ContactSegments
@@ -3406,7 +3512,7 @@ $client->contacts->listAttachedSegments(
-
$client->contacts->listAttachedSubscriptions($request) -> SubscriptionTypeList +
$client->contacts->listAttachedSubscriptions($request) -> SubscriptionTypeList
@@ -3470,7 +3576,7 @@ $client->contacts->listAttachedSubscriptions(
-
$client->contacts->attachSubscription($request) -> SubscriptionType +
$client->contacts->attachSubscription($request) -> SubscriptionType
@@ -3552,7 +3658,7 @@ $client->contacts->attachSubscription(
-
$client->contacts->detachSubscription($request) -> SubscriptionType +
$client->contacts->detachSubscription($request) -> SubscriptionType
@@ -3619,7 +3725,7 @@ $client->contacts->detachSubscription(
-
$client->contacts->listAttachedTags($request) -> TagList +
$client->contacts->listAttachedTags($request) -> TagList
@@ -3677,7 +3783,7 @@ $client->contacts->listAttachedTags(
-
$client->contacts->find($request) -> ContactsFindResponse +
$client->contacts->find($request) -> ContactsFindResponse
@@ -3735,7 +3841,7 @@ $client->contacts->find(
-
$client->contacts->update($request) -> ContactsUpdateResponse +
$client->contacts->update($request) -> ContactsUpdateResponse
@@ -3889,7 +3995,7 @@ $client->contacts->update(
-
$client->contacts->delete($request) -> ContactDeleted +
$client->contacts->delete($request) -> ContactDeleted
@@ -3947,7 +4053,7 @@ $client->contacts->delete(
-
$client->contacts->mergeLeadInUser($request) -> ContactsMergeLeadInUserResponse +
$client->contacts->mergeLeadInUser($request) -> ContactsMergeLeadInUserResponse
@@ -4014,7 +4120,7 @@ $client->contacts->mergeLeadInUser(
-
$client->contacts->search($request) -> ContactList +
$client->contacts->search($request) -> ContactList
@@ -4173,7 +4279,7 @@ $client->unstable->contacts->searchContacts(
-
$client->contacts->list($request) -> ContactList +
$client->contacts->list($request) -> ContactList
@@ -4249,7 +4355,7 @@ $client->contacts->list(
-
$client->contacts->create($request) -> ContactsCreateResponse +
$client->contacts->create($request) -> ContactsCreateResponse
@@ -4307,7 +4413,7 @@ $client->contacts->create(
-
$client->contacts->showContactByExternalId($request) -> ShowContactByExternalIdResponse +
$client->contacts->showContactByExternalId($request) -> ShowContactByExternalIdResponse
@@ -4365,7 +4471,7 @@ $client->contacts->showContactByExternalId(
-
$client->contacts->archive($request) -> ContactArchived +
$client->contacts->archive($request) -> ContactArchived
@@ -4423,7 +4529,7 @@ $client->contacts->archive(
-
$client->contacts->unarchive($request) -> ContactUnarchived +
$client->contacts->unarchive($request) -> ContactUnarchived
@@ -4481,7 +4587,7 @@ $client->contacts->unarchive(
-
$client->contacts->blockContact($request) -> ContactBlocked +
$client->contacts->blockContact($request) -> ContactBlocked
@@ -4540,7 +4646,7 @@ $client->contacts->blockContact(
## Notes -
$client->notes->list($request) -> NoteList +
$client->notes->list($request) -> NoteList
@@ -4614,7 +4720,7 @@ $client->notes->list(
-
$client->notes->create($request) -> Note +
$client->notes->create($request) -> Note
@@ -4690,7 +4796,7 @@ $client->notes->create(
-
$client->notes->find($request) -> Note +
$client->notes->find($request) -> Note
@@ -4749,7 +4855,7 @@ $client->notes->find(
## Tags -
$client->tags->tagContact($request) -> Tag +
$client->tags->tagContact($request) -> Tag
@@ -4816,7 +4922,7 @@ $client->tags->tagContact(
-
$client->tags->untagContact($request) -> Tag +
$client->tags->untagContact($request) -> Tag
@@ -4883,7 +4989,7 @@ $client->tags->untagContact(
-
$client->tags->tagConversation($request) -> Tag +
$client->tags->tagConversation($request) -> Tag
@@ -4959,7 +5065,7 @@ $client->tags->tagConversation(
-
$client->tags->untagConversation($request) -> Tag +
$client->tags->untagConversation($request) -> Tag
@@ -5035,7 +5141,7 @@ $client->tags->untagConversation(
-
$client->tags->list() -> TagList +
$client->tags->list() -> TagList
@@ -5075,7 +5181,7 @@ $client->tags->list();
-
$client->tags->create($request) -> Tag +
$client->tags->create($request) -> Tag
@@ -5145,7 +5251,7 @@ $client->tags->create(
-
$client->tags->find($request) -> Tag +
$client->tags->find($request) -> Tag
@@ -5204,7 +5310,7 @@ $client->tags->find(
-
$client->tags->delete($request) +
$client->tags->delete($request)
@@ -5262,7 +5368,7 @@ $client->tags->delete(
-
$client->tags->tagTicket($request) -> Tag +
$client->tags->tagTicket($request) -> Tag
@@ -5338,7 +5444,7 @@ $client->tags->tagTicket(
-
$client->tags->untagTicket($request) -> Tag +
$client->tags->untagTicket($request) -> Tag
@@ -5415,7 +5521,7 @@ $client->tags->untagTicket(
## Conversations -
$client->conversations->list($request) -> ConversationList +
$client->conversations->list($request) -> ConversationList
@@ -5488,7 +5594,7 @@ $client->conversations->list(
-
$client->conversations->create($request) -> Message +
$client->conversations->create($request) -> Message
@@ -5575,7 +5681,7 @@ $client->conversations->create(
-
$client->conversations->find($request) -> Conversation +
$client->conversations->find($request) -> Conversation
@@ -5660,7 +5766,7 @@ $client->conversations->find(
-
$client->conversations->update($request) -> Conversation +
$client->conversations->update($request) -> Conversation
@@ -5777,7 +5883,7 @@ $client->conversations->update(
-
$client->conversations->deleteConversation($request) -> ConversationDeleted +
$client->conversations->deleteConversation($request) -> ConversationDeleted
@@ -5835,7 +5941,7 @@ $client->conversations->deleteConversation(
-
$client->conversations->search($request) -> ConversationList +
$client->conversations->search($request) -> ConversationList
@@ -5994,7 +6100,7 @@ $client->unstable->conversations->searchConversations(
-
$client->conversations->reply($request) -> Conversation +
$client->conversations->reply($request) -> Conversation
@@ -6066,7 +6172,7 @@ $client->conversations->reply(
-
$client->conversations->manage($request) -> Conversation +
$client->conversations->manage($request) -> Conversation
@@ -6140,7 +6246,7 @@ $client->conversations->manage(
-
$client->conversations->attachContactAsAdmin($request) -> Conversation +
$client->conversations->attachContactAsAdmin($request) -> Conversation
@@ -6223,7 +6329,7 @@ $client->conversations->attachContactAsAdmin(
-
$client->conversations->detachContactAsAdmin($request) -> Conversation +
$client->conversations->detachContactAsAdmin($request) -> Conversation
@@ -6304,7 +6410,7 @@ $client->conversations->detachContactAsAdmin(
-
$client->conversations->redactConversationPart($request) -> Conversation +
$client->conversations->redactConversationPart($request) -> Conversation
@@ -6368,7 +6474,7 @@ $client->conversations->redactConversationPart(
-
$client->conversations->convertToTicket($request) -> ?Ticket +
$client->conversations->convertToTicket($request) -> ?Ticket
@@ -6443,7 +6549,7 @@ $client->conversations->convertToTicket(
-
$client->conversations->runAssignmentRules($request) -> Conversation +
$client->conversations->runAssignmentRules($request) -> Conversation
@@ -6508,7 +6614,7 @@ $client->conversations->runAssignmentRules(
## Custom Channel Events -
$client->customChannelEvents->notifyNewConversation($request) -> CustomChannelNotificationResponse +
$client->customChannelEvents->notifyNewConversation($request) -> CustomChannelNotificationResponse
@@ -6572,7 +6678,7 @@ $client->customChannelEvents->notifyNewConversation(
-
$client->customChannelEvents->notifyNewMessage($request) -> CustomChannelNotificationResponse +
$client->customChannelEvents->notifyNewMessage($request) -> CustomChannelNotificationResponse
@@ -6637,7 +6743,7 @@ $client->customChannelEvents->notifyNewMessage(
-
$client->customChannelEvents->notifyQuickReplySelected($request) -> CustomChannelNotificationResponse +
$client->customChannelEvents->notifyQuickReplySelected($request) -> CustomChannelNotificationResponse
@@ -6704,7 +6810,7 @@ $client->customChannelEvents->notifyQuickReplySelected(
-
$client->customChannelEvents->notifyAttributeCollected($request) -> CustomChannelNotificationResponse +
$client->customChannelEvents->notifyAttributeCollected($request) -> CustomChannelNotificationResponse
@@ -6773,7 +6879,7 @@ $client->customChannelEvents->notifyAttributeCollected(
## Custom Object Instances -
$client->customObjectInstances->getCustomObjectInstancesByExternalId($request) -> ?CustomObjectInstance +
$client->customObjectInstances->getCustomObjectInstancesByExternalId($request) -> ?CustomObjectInstance
@@ -6840,7 +6946,7 @@ $client->customObjectInstances->getCustomObjectInstancesByExternalId(
-
$client->customObjectInstances->createCustomObjectInstances($request) -> ?CustomObjectInstance +
$client->customObjectInstances->createCustomObjectInstances($request) -> ?CustomObjectInstance
@@ -6937,7 +7043,7 @@ $client->customObjectInstances->createCustomObjectInstances(
-
$client->customObjectInstances->deleteCustomObjectInstancesById($request) -> CustomObjectInstanceDeleted +
$client->customObjectInstances->deleteCustomObjectInstancesById($request) -> CustomObjectInstanceDeleted
@@ -7004,7 +7110,7 @@ $client->customObjectInstances->deleteCustomObjectInstancesById(
-
$client->customObjectInstances->getCustomObjectInstancesById($request) -> ?CustomObjectInstance +
$client->customObjectInstances->getCustomObjectInstancesById($request) -> ?CustomObjectInstance
@@ -7071,7 +7177,7 @@ $client->customObjectInstances->getCustomObjectInstancesById(
-
$client->customObjectInstances->deleteCustomObjectInstancesByExternalId($request) -> CustomObjectInstanceDeleted +
$client->customObjectInstances->deleteCustomObjectInstancesByExternalId($request) -> CustomObjectInstanceDeleted
@@ -7139,7 +7245,7 @@ $client->customObjectInstances->deleteCustomObjectInstancesByExternalId(
## Data Attributes -
$client->dataAttributes->list($request) -> DataAttributeList +
$client->dataAttributes->list($request) -> DataAttributeList
@@ -7206,7 +7312,7 @@ $client->dataAttributes->list(
-
$client->dataAttributes->create($request) -> DataAttribute +
$client->dataAttributes->create($request) -> DataAttribute
@@ -7264,7 +7370,7 @@ $client->dataAttributes->create(
-
$client->dataAttributes->update($request) -> DataAttribute +
$client->dataAttributes->update($request) -> DataAttribute
@@ -7346,7 +7452,7 @@ $client->dataAttributes->update(
## Events -
$client->events->list($request) -> DataEventSummary +
$client->events->list($request) -> DataEventSummary
@@ -7462,7 +7568,7 @@ $client->events->list(
-
$client->events->create($request) +
$client->events->create($request)
@@ -7563,7 +7669,7 @@ $client->events->create(
-
$client->events->summaries($request) +
$client->events->summaries($request)
@@ -7629,7 +7735,7 @@ $client->events->summaries(
## Jobs -
$client->jobs->status($request) -> Jobs +
$client->jobs->status($request) -> Jobs
@@ -7688,7 +7794,7 @@ $client->jobs->status(
## Messages -
$client->messages->create($request) -> Message +
$client->messages->create($request) -> Message
@@ -7767,7 +7873,7 @@ $client->messages->create(
## Segments -
$client->segments->list($request) -> SegmentList +
$client->segments->list($request) -> SegmentList
@@ -7825,7 +7931,7 @@ $client->segments->list(
-
$client->segments->find($request) -> Segment +
$client->segments->find($request) -> Segment
@@ -7884,7 +7990,7 @@ $client->segments->find(
## Subscription Types -
$client->subscriptionTypes->list() -> SubscriptionTypeList +
$client->subscriptionTypes->list() -> SubscriptionTypeList
@@ -7924,7 +8030,7 @@ $client->subscriptionTypes->list();
## PhoneCallRedirects -
$client->phoneCallRedirects->create($request) -> ?PhoneSwitch +
$client->phoneCallRedirects->create($request) -> ?PhoneSwitch
@@ -7990,7 +8096,7 @@ $client->phoneCallRedirects->create(
## Calls -
$client->calls->listCalls($request) -> CallList +
$client->calls->listCalls($request) -> CallList
@@ -8057,7 +8163,7 @@ $client->calls->listCalls(
-
$client->calls->showCall($request) -> Call +
$client->calls->showCall($request) -> Call
@@ -8115,7 +8221,7 @@ $client->calls->showCall(
-
$client->calls->showCallRecording($request) +
$client->calls->showCallRecording($request)
@@ -8173,7 +8279,7 @@ $client->calls->showCallRecording(
-
$client->calls->showCallTranscript($request) -> string +
$client->calls->showCallTranscript($request) -> string
@@ -8231,7 +8337,7 @@ $client->calls->showCallTranscript(
-
$client->calls->listCallsWithTranscripts($request) -> ListCallsWithTranscriptsResponse +
$client->calls->listCallsWithTranscripts($request) -> ListCallsWithTranscriptsResponse
@@ -8294,7 +8400,7 @@ $client->calls->listCallsWithTranscripts(
## Teams -
$client->teams->list() -> TeamList +
$client->teams->list() -> TeamList
@@ -8333,7 +8439,7 @@ $client->teams->list();
-
$client->teams->find($request) -> Team +
$client->teams->find($request) -> Team
@@ -8392,7 +8498,7 @@ $client->teams->find(
## Ticket States -
$client->ticketStates->listTicketStates() -> TicketStateList +
$client->ticketStates->listTicketStates() -> TicketStateList
@@ -8432,7 +8538,7 @@ $client->ticketStates->listTicketStates();
## Ticket Types -
$client->ticketTypes->list() -> TicketTypeList +
$client->ticketTypes->list() -> TicketTypeList
@@ -8471,7 +8577,7 @@ $client->ticketTypes->list();
-
$client->ticketTypes->create($request) -> ?TicketType +
$client->ticketTypes->create($request) -> ?TicketType
@@ -8536,7 +8642,7 @@ $client->ticketTypes->create(
-
$client->ticketTypes->get($request) -> ?TicketType +
$client->ticketTypes->get($request) -> ?TicketType
@@ -8594,7 +8700,7 @@ $client->ticketTypes->get(
-
$client->ticketTypes->update($request) -> ?TicketType +
$client->ticketTypes->update($request) -> ?TicketType
@@ -8707,7 +8813,7 @@ $client->ticketTypes->update(
## Tickets -
$client->tickets->reply($request) -> TicketReply +
$client->tickets->reply($request) -> TicketReply
@@ -8779,7 +8885,7 @@ $client->tickets->reply(
-
$client->tickets->create($request) -> ?Ticket +
$client->tickets->create($request) -> ?Ticket
@@ -8842,7 +8948,7 @@ $client->tickets->create(
-
$client->tickets->enqueueCreateTicket($request) -> Jobs +
$client->tickets->enqueueCreateTicket($request) -> Jobs
@@ -8905,7 +9011,7 @@ $client->tickets->enqueueCreateTicket(
-
$client->tickets->get($request) -> ?Ticket +
$client->tickets->get($request) -> ?Ticket
@@ -8963,7 +9069,7 @@ $client->tickets->get(
-
$client->tickets->update($request) -> ?Ticket +
$client->tickets->update($request) -> ?Ticket
@@ -9094,7 +9200,7 @@ $client->tickets->update(
-
$client->tickets->deleteTicket($request) -> DeleteTicketResponse +
$client->tickets->deleteTicket($request) -> DeleteTicketResponse
@@ -9152,7 +9258,7 @@ $client->tickets->deleteTicket(
-
$client->tickets->search($request) -> TicketList +
$client->tickets->search($request) -> TicketList
@@ -9282,7 +9388,7 @@ $client->unstable->tickets->searchTickets(
## Visitors -
$client->visitors->find($request) -> ?Visitor +
$client->visitors->find($request) -> ?Visitor
@@ -9340,7 +9446,7 @@ $client->visitors->find(
-
$client->visitors->update($request) -> ?Visitor +
$client->visitors->update($request) -> ?Visitor
@@ -9403,7 +9509,7 @@ $client->visitors->update(
-
$client->visitors->mergeToContact($request) -> Contact +
$client->visitors->mergeToContact($request) -> Contact
@@ -9489,7 +9595,7 @@ $client->unstable->visitors->convertVisitor(
## HelpCenters Collections -
$client->helpCenters->collections->list($request) -> CollectionList +
$client->helpCenters->collections->list($request) -> CollectionList
@@ -9555,7 +9661,7 @@ $client->helpCenters->collections->list(
-
$client->helpCenters->collections->create($request) -> Collection +
$client->helpCenters->collections->create($request) -> Collection
@@ -9645,7 +9751,7 @@ $client->helpCenters->collections->create(
-
$client->helpCenters->collections->find($request) -> Collection +
$client->helpCenters->collections->find($request) -> Collection
@@ -9703,7 +9809,7 @@ $client->helpCenters->collections->find(
-
$client->helpCenters->collections->update($request) -> Collection +
$client->helpCenters->collections->update($request) -> Collection
@@ -9794,7 +9900,7 @@ $client->helpCenters->collections->update(
-
$client->helpCenters->collections->delete($request) -> DeletedCollectionObject +
$client->helpCenters->collections->delete($request) -> DeletedCollectionObject
@@ -9853,7 +9959,7 @@ $client->helpCenters->collections->delete(
## News Items -
$client->news->items->list() -> PaginatedResponse +
$client->news->items->list() -> PaginatedResponse
@@ -9892,7 +9998,7 @@ $client->news->items->list();
-
$client->news->items->create($request) -> NewsItem +
$client->news->items->create($request) -> NewsItem
@@ -9969,7 +10075,7 @@ $client->news->items->create(
-
$client->news->items->find($request) -> NewsItem +
$client->news->items->find($request) -> NewsItem
@@ -10027,7 +10133,7 @@ $client->news->items->find(
-
$client->news->items->update($request) -> NewsItem +
$client->news->items->update($request) -> NewsItem
@@ -10088,7 +10194,7 @@ $client->news->items->update(
-
$client->news->items->delete($request) -> DeletedObject +
$client->news->items->delete($request) -> DeletedObject
@@ -10147,7 +10253,7 @@ $client->news->items->delete(
## News Feeds -
$client->news->feeds->listItems($request) -> PaginatedResponse +
$client->news->feeds->listItems($request) -> PaginatedResponse
@@ -10205,7 +10311,7 @@ $client->news->feeds->listItems(
-
$client->news->feeds->list() -> PaginatedResponse +
$client->news->feeds->list() -> PaginatedResponse
@@ -10244,7 +10350,7 @@ $client->news->feeds->list();
-
$client->news->feeds->find($request) -> Newsfeed +
$client->news->feeds->find($request) -> Newsfeed
@@ -10303,7 +10409,7 @@ $client->news->feeds->find(
## TicketTypes Attributes -
$client->ticketTypes->attributes->create($request) -> ?TicketTypeAttribute +
$client->ticketTypes->attributes->create($request) -> ?TicketTypeAttribute
@@ -10445,7 +10551,7 @@ $client->ticketTypes->attributes->create(
-
$client->ticketTypes->attributes->update($request) -> ?TicketTypeAttribute +
$client->ticketTypes->attributes->update($request) -> ?TicketTypeAttribute
@@ -10594,7 +10700,7 @@ $client->ticketTypes->attributes->update(
## Admins -
$client->unstable->admins->identifyAdmin() -> ?AdminWithApp +
$client->unstable->admins->identifyAdmin() -> ?AdminWithApp
@@ -10638,7 +10744,7 @@ $client->admins->identify();
-
$client->unstable->admins->setAwayAdmin($request) -> ?Admin +
$client->unstable->admins->setAwayAdmin($request) -> ?Admin
@@ -10723,7 +10829,7 @@ $client->unstable->admins->setAwayAdmin(
-
$client->unstable->admins->listActivityLogs($request) -> ActivityLogList +
$client->unstable->admins->listActivityLogs($request) -> ActivityLogList
@@ -10790,7 +10896,7 @@ $client->admins->listAllActivityLogs(
-
$client->unstable->admins->listAdmins() -> AdminList +
$client->unstable->admins->listAdmins() -> AdminList
@@ -10829,7 +10935,7 @@ $client->admins->list();
-
$client->unstable->admins->retrieveAdmin($request) -> ?Admin +
$client->unstable->admins->retrieveAdmin($request) -> ?Admin
@@ -10888,7 +10994,7 @@ $client->unstable->admins->retrieveAdmin(
## AI Content -
$client->unstable->aiContent->listContentImportSources() -> ContentImportSourcesList +
$client->unstable->aiContent->listContentImportSources() -> ContentImportSourcesList
@@ -10927,7 +11033,7 @@ $client->aiContent->listContentImportSources();
-
$client->unstable->aiContent->createContentImportSource($request) -> ContentImportSource +
$client->unstable->aiContent->createContentImportSource($request) -> ContentImportSource
@@ -11002,7 +11108,7 @@ $client->aiContent->createContentImportSource(
-
$client->unstable->aiContent->getContentImportSource($request) -> ContentImportSource +
$client->unstable->aiContent->getContentImportSource($request) -> ContentImportSource
@@ -11046,7 +11152,7 @@ $client->unstable->aiContent->getContentImportSource(
-
$client->unstable->aiContent->updateContentImportSource($request) -> ContentImportSource +
$client->unstable->aiContent->updateContentImportSource($request) -> ContentImportSource
@@ -11130,7 +11236,7 @@ $client->unstable->aiContent->updateContentImportSource(
-
$client->unstable->aiContent->deleteContentImportSource($request) +
$client->unstable->aiContent->deleteContentImportSource($request)
@@ -11188,7 +11294,7 @@ $client->unstable->aiContent->deleteContentImportSource(
-
$client->unstable->aiContent->listExternalPages() -> ExternalPagesList +
$client->unstable->aiContent->listExternalPages() -> ExternalPagesList
@@ -11227,7 +11333,7 @@ $client->aiContent->listExternalPages();
-
$client->unstable->aiContent->createExternalPage($request) -> ExternalPage +
$client->unstable->aiContent->createExternalPage($request) -> ExternalPage
@@ -11346,7 +11452,7 @@ $client->aiContent->createExternalPage(
-
$client->unstable->aiContent->getExternalPage($request) -> ExternalPage +
$client->unstable->aiContent->getExternalPage($request) -> ExternalPage
@@ -11404,7 +11510,7 @@ $client->unstable->aiContent->getExternalPage(
-
$client->unstable->aiContent->updateExternalPage($request) -> ExternalPage +
$client->unstable->aiContent->updateExternalPage($request) -> ExternalPage
@@ -11524,7 +11630,7 @@ $client->unstable->aiContent->updateExternalPage(
-
$client->unstable->aiContent->deleteExternalPage($request) -> ExternalPage +
$client->unstable->aiContent->deleteExternalPage($request) -> ExternalPage
@@ -11583,7 +11689,7 @@ $client->unstable->aiContent->deleteExternalPage(
## Articles -
$client->unstable->articles->listArticles() -> ArticleList +
$client->unstable->articles->listArticles() -> ArticleList
@@ -11628,7 +11734,7 @@ $client->articles->list(
-
$client->unstable->articles->createArticle($request) -> Article +
$client->unstable->articles->createArticle($request) -> Article
@@ -11686,7 +11792,7 @@ $client->unstable->articles->createArticle(
-
$client->unstable->articles->retrieveArticle($request) -> Article +
$client->unstable->articles->retrieveArticle($request) -> Article
@@ -11744,7 +11850,7 @@ $client->unstable->articles->retrieveArticle(
-
$client->unstable->articles->deleteArticle($request) -> DeletedArticleObject +
$client->unstable->articles->deleteArticle($request) -> DeletedArticleObject
@@ -11802,7 +11908,7 @@ $client->unstable->articles->deleteArticle(
-
$client->unstable->articles->searchArticles($request) -> ArticleSearchResponse +
$client->unstable->articles->searchArticles($request) -> ArticleSearchResponse
@@ -11888,7 +11994,7 @@ $client->articles->search(
## Away Status Reasons -
$client->unstable->awayStatusReasons->listAwayStatusReasons() -> array +
$client->unstable->awayStatusReasons->listAwayStatusReasons() -> array
@@ -11928,7 +12034,7 @@ $client->awayStatusReasons->listAwayStatusReasons();
## Unstable Export -
$client->unstable->export->enqueueANewReportingDataExportJob($request) -> PostExportReportingDataEnqueueResponse +
$client->unstable->export->enqueueANewReportingDataExportJob($request) -> PostExportReportingDataEnqueueResponse
@@ -12002,7 +12108,7 @@ $client->export->enqueueANewReportingDataExportJob(
-
$client->unstable->export->listAvailableDatasetsAndAttributes() -> GetExportReportingDataGetDatasetsResponse +
$client->unstable->export->listAvailableDatasetsAndAttributes() -> GetExportReportingDataGetDatasetsResponse
@@ -12028,7 +12134,7 @@ $client->export->listAvailableDatasetsAndAttributes();
## Help Center -
$client->unstable->helpCenter->listAllCollections() -> CollectionList +
$client->unstable->helpCenter->listAllCollections() -> CollectionList
@@ -12071,7 +12177,7 @@ $client->helpCenters->collections->list(
-
$client->unstable->helpCenter->createCollection($request) -> Collection +
$client->unstable->helpCenter->createCollection($request) -> Collection
@@ -12161,7 +12267,7 @@ $client->helpCenters->collections->create(
-
$client->unstable->helpCenter->retrieveCollection($request) -> Collection +
$client->unstable->helpCenter->retrieveCollection($request) -> Collection
@@ -12219,7 +12325,7 @@ $client->unstable->helpCenter->retrieveCollection(
-
$client->unstable->helpCenter->updateCollection($request) -> Collection +
$client->unstable->helpCenter->updateCollection($request) -> Collection
@@ -12310,7 +12416,7 @@ $client->unstable->helpCenter->updateCollection(
-
$client->unstable->helpCenter->deleteCollection($request) -> DeletedCollectionObject +
$client->unstable->helpCenter->deleteCollection($request) -> DeletedCollectionObject
@@ -12368,7 +12474,7 @@ $client->unstable->helpCenter->deleteCollection(
-
$client->unstable->helpCenter->retrieveHelpCenter($request) -> HelpCenter +
$client->unstable->helpCenter->retrieveHelpCenter($request) -> HelpCenter
@@ -12426,7 +12532,7 @@ $client->unstable->helpCenter->retrieveHelpCenter(
-
$client->unstable->helpCenter->listHelpCenters() -> HelpCenterList +
$client->unstable->helpCenter->listHelpCenters() -> HelpCenterList
@@ -12468,7 +12574,7 @@ $client->helpCenters->list(
## Internal Articles -
$client->unstable->internalArticles->listInternalArticles() -> InternalArticleList +
$client->unstable->internalArticles->listInternalArticles() -> InternalArticleList
@@ -12507,7 +12613,7 @@ $client->internalArticles->listInternalArticles();
-
$client->unstable->internalArticles->createInternalArticle($request) -> InternalArticleListItem +
$client->unstable->internalArticles->createInternalArticle($request) -> InternalArticleListItem
@@ -12568,7 +12674,7 @@ $client->internalArticles->createInternalArticle(
-
$client->unstable->internalArticles->retrieveInternalArticle($request) -> InternalArticleListItem +
$client->unstable->internalArticles->retrieveInternalArticle($request) -> InternalArticleListItem
@@ -12626,7 +12732,7 @@ $client->unstable->internalArticles->retrieveInternalArticle(
-
$client->unstable->internalArticles->updateInternalArticle($request) -> InternalArticleListItem +
$client->unstable->internalArticles->updateInternalArticle($request) -> InternalArticleListItem
@@ -12718,7 +12824,7 @@ $client->unstable->internalArticles->updateInternalArticle(
-
$client->unstable->internalArticles->deleteInternalArticle($request) -> DeletedInternalArticleObject +
$client->unstable->internalArticles->deleteInternalArticle($request) -> DeletedInternalArticleObject
@@ -12776,7 +12882,7 @@ $client->unstable->internalArticles->deleteInternalArticle(
-
$client->unstable->internalArticles->searchInternalArticles($request) -> InternalArticleSearchResponse +
$client->unstable->internalArticles->searchInternalArticles($request) -> InternalArticleSearchResponse
@@ -12835,7 +12941,7 @@ $client->internalArticles->searchInternalArticles(
## Companies -
$client->unstable->companies->retrieveCompany($request) -> CompanyList +
$client->unstable->companies->retrieveCompany($request) -> CompanyList
@@ -12948,7 +13054,7 @@ $client->companies->retrieve(
-
$client->unstable->companies->createOrUpdateCompany($request) -> Company +
$client->unstable->companies->createOrUpdateCompany($request) -> Company
@@ -13014,7 +13120,7 @@ $client->unstable->companies->createOrUpdateCompany(
-
$client->unstable->companies->retrieveACompanyById($request) -> Company +
$client->unstable->companies->retrieveACompanyById($request) -> Company
@@ -13072,7 +13178,7 @@ $client->unstable->companies->retrieveACompanyById(
-
$client->unstable->companies->updateCompany($request) -> Company +
$client->unstable->companies->updateCompany($request) -> Company
@@ -13134,7 +13240,7 @@ $client->unstable->companies->updateCompany(
-
$client->unstable->companies->deleteCompany($request) -> DeletedCompanyObject +
$client->unstable->companies->deleteCompany($request) -> DeletedCompanyObject
@@ -13192,7 +13298,7 @@ $client->unstable->companies->deleteCompany(
-
$client->unstable->companies->listAttachedContacts($request) -> CompanyAttachedContacts +
$client->unstable->companies->listAttachedContacts($request) -> CompanyAttachedContacts
@@ -13250,7 +13356,7 @@ $client->unstable->companies->listAttachedContacts(
-
$client->unstable->companies->listAttachedSegmentsForCompanies($request) -> CompanyAttachedSegments +
$client->unstable->companies->listAttachedSegmentsForCompanies($request) -> CompanyAttachedSegments
@@ -13308,7 +13414,7 @@ $client->unstable->companies->listAttachedSegmentsForCompanies(
-
$client->unstable->companies->listAllCompanies($request) -> CompanyList +
$client->unstable->companies->listAllCompanies($request) -> CompanyList
@@ -13392,7 +13498,7 @@ $client->companies->list(
-
$client->unstable->companies->scrollOverAllCompanies($request) -> ?CompanyScroll +
$client->unstable->companies->scrollOverAllCompanies($request) -> ?CompanyScroll
@@ -13464,7 +13570,7 @@ $client->companies->scroll(
-
$client->unstable->companies->attachContactToACompany($request) -> Company +
$client->unstable->companies->attachContactToACompany($request) -> Company
@@ -13531,7 +13637,7 @@ $client->unstable->companies->attachContactToACompany(
-
$client->unstable->companies->detachContactFromACompany($request) -> Company +
$client->unstable->companies->detachContactFromACompany($request) -> Company
@@ -13599,7 +13705,7 @@ $client->unstable->companies->detachContactFromACompany(
## Notes -
$client->unstable->notes->listCompanyNotes($request) -> NoteList +
$client->unstable->notes->listCompanyNotes($request) -> NoteList
@@ -13657,7 +13763,7 @@ $client->unstable->notes->listCompanyNotes(
-
$client->unstable->notes->listNotes($request) -> NoteList +
$client->unstable->notes->listNotes($request) -> NoteList
@@ -13715,7 +13821,7 @@ $client->unstable->notes->listNotes(
-
$client->unstable->notes->createNote($request) -> Note +
$client->unstable->notes->createNote($request) -> Note
@@ -13800,7 +13906,7 @@ $client->unstable->notes->createNote(
-
$client->unstable->notes->retrieveNote($request) -> Note +
$client->unstable->notes->retrieveNote($request) -> Note
@@ -13859,7 +13965,7 @@ $client->unstable->notes->retrieveNote(
## Contacts -
$client->unstable->contacts->listCompaniesForAContact($request) -> ContactAttachedCompanies +
$client->unstable->contacts->listCompaniesForAContact($request) -> ContactAttachedCompanies
@@ -13917,7 +14023,7 @@ $client->unstable->contacts->listCompaniesForAContact(
-
$client->unstable->contacts->listSegmentsForAContact($request) -> ContactSegments +
$client->unstable->contacts->listSegmentsForAContact($request) -> ContactSegments
@@ -13975,7 +14081,7 @@ $client->contacts->listAttachedSegments(
-
$client->unstable->contacts->listSubscriptionsForAContact($request) -> SubscriptionTypeList +
$client->unstable->contacts->listSubscriptionsForAContact($request) -> SubscriptionTypeList
@@ -14039,7 +14145,7 @@ $client->contacts->listAttachedSubscriptions(
-
$client->unstable->contacts->listTagsForAContact($request) -> TagList +
$client->unstable->contacts->listTagsForAContact($request) -> TagList
@@ -14097,7 +14203,7 @@ $client->contacts->listAttachedTags(
-
$client->unstable->contacts->showContact($request) -> ShowContactResponse +
$client->unstable->contacts->showContact($request) -> ShowContactResponse
@@ -14155,7 +14261,7 @@ $client->unstable->contacts->showContact(
-
$client->unstable->contacts->updateContact($request) -> UpdateContactResponse +
$client->unstable->contacts->updateContact($request) -> UpdateContactResponse
@@ -14297,6 +14403,14 @@ $client->unstable->contacts->updateContact(
+**$languageOverride:** `?string` — A preferred language setting for the contact, used by Intercom as the language of Fin and the Messenger even if their browser has a different setting. Supports ISO 639-1 two-letter language codes. If an unsupported code is supplied, the field will be set to null. + +
+
+ +
+
+ **$customAttributes:** `?array` — The custom attributes which are set for the contact
@@ -14309,7 +14423,7 @@ $client->unstable->contacts->updateContact(
-
$client->unstable->contacts->deleteContact($request) -> ContactDeleted +
$client->unstable->contacts->deleteContact($request) -> ContactDeleted
@@ -14367,7 +14481,7 @@ $client->unstable->contacts->deleteContact(
-
$client->unstable->contacts->mergeContact($request) -> MergeContactResponse +
$client->unstable->contacts->mergeContact($request) -> MergeContactResponse
@@ -14434,7 +14548,7 @@ $client->contacts->mergeLeadInUser(
-
$client->unstable->contacts->searchContacts($request) -> ContactList +
$client->unstable->contacts->searchContacts($request) -> ContactList
@@ -14594,7 +14708,7 @@ $client->unstable->contacts->searchContacts(
-
$client->unstable->contacts->listContacts() -> ContactList +
$client->unstable->contacts->listContacts() -> ContactList
@@ -14639,7 +14753,7 @@ $client->contacts->list(
-
$client->unstable->contacts->createContact($request) -> CreateContactResponse +
$client->unstable->contacts->createContact($request) -> CreateContactResponse
@@ -14697,7 +14811,7 @@ $client->contacts->create(
-
$client->unstable->contacts->showContactByExternalId($request) -> ShowContactByExternalIdResponse +
$client->unstable->contacts->showContactByExternalId($request) -> ShowContactByExternalIdResponse
@@ -14755,7 +14869,7 @@ $client->contacts->showContactByExternalId(
-
$client->unstable->contacts->archiveContact($request) -> ContactArchived +
$client->unstable->contacts->archiveContact($request) -> ContactArchived
@@ -14813,7 +14927,7 @@ $client->unstable->contacts->archiveContact(
-
$client->unstable->contacts->unarchiveContact($request) -> ContactUnarchived +
$client->unstable->contacts->unarchiveContact($request) -> ContactUnarchived
@@ -14871,7 +14985,7 @@ $client->unstable->contacts->unarchiveContact(
-
$client->unstable->contacts->blockContact($request) -> ContactBlocked +
$client->unstable->contacts->blockContact($request) -> ContactBlocked
@@ -14930,7 +15044,7 @@ $client->unstable->contacts->blockContact(
## Subscription Types -
$client->unstable->subscriptionTypes->attachSubscriptionTypeToContact($request) -> SubscriptionType +
$client->unstable->subscriptionTypes->attachSubscriptionTypeToContact($request) -> SubscriptionType
@@ -15012,7 +15126,7 @@ $client->contacts->attachSubscription(
-
$client->unstable->subscriptionTypes->detachSubscriptionTypeToContact($request) -> SubscriptionType +
$client->unstable->subscriptionTypes->detachSubscriptionTypeToContact($request) -> SubscriptionType
@@ -15079,7 +15193,7 @@ $client->unstable->subscriptionTypes->detachSubscriptionTypeToContact(
-
$client->unstable->subscriptionTypes->listSubscriptionTypes() -> SubscriptionTypeList +
$client->unstable->subscriptionTypes->listSubscriptionTypes() -> SubscriptionTypeList
@@ -15119,7 +15233,7 @@ $client->subscriptionTypes->list();
## Tags -
$client->unstable->tags->attachTagToContact($request) -> Tag +
$client->unstable->tags->attachTagToContact($request) -> Tag
@@ -15186,7 +15300,7 @@ $client->tags->tagContact(
-
$client->unstable->tags->detachTagFromContact($request) -> Tag +
$client->unstable->tags->detachTagFromContact($request) -> Tag
@@ -15253,7 +15367,7 @@ $client->unstable->tags->detachTagFromContact(
-
$client->unstable->tags->attachTagToConversation($request) -> Tag +
$client->unstable->tags->attachTagToConversation($request) -> Tag
@@ -15329,7 +15443,7 @@ $client->tags->tagConversation(
-
$client->unstable->tags->detachTagFromConversation($request) -> Tag +
$client->unstable->tags->detachTagFromConversation($request) -> Tag
@@ -15405,7 +15519,7 @@ $client->unstable->tags->detachTagFromConversation(
-
$client->unstable->tags->listTags() -> TagList +
$client->unstable->tags->listTags() -> TagList
@@ -15445,7 +15559,7 @@ $client->tags->list();
-
$client->unstable->tags->createTag($request) -> Tag +
$client->unstable->tags->createTag($request) -> Tag
@@ -15515,7 +15629,7 @@ $client->tags->create(
-
$client->unstable->tags->findTag($request) -> Tag +
$client->unstable->tags->findTag($request) -> Tag
@@ -15574,7 +15688,7 @@ $client->unstable->tags->findTag(
-
$client->unstable->tags->deleteTag($request) +
$client->unstable->tags->deleteTag($request)
@@ -15632,7 +15746,7 @@ $client->unstable->tags->deleteTag(
-
$client->unstable->tags->attachTagToTicket($request) -> Tag +
$client->unstable->tags->attachTagToTicket($request) -> Tag
@@ -15708,7 +15822,7 @@ $client->tags->tagTicket(
-
$client->unstable->tags->detachTagFromTicket($request) -> Tag +
$client->unstable->tags->detachTagFromTicket($request) -> Tag
@@ -15785,7 +15899,7 @@ $client->unstable->tags->detachTagFromTicket(
## Conversations -
$client->unstable->conversations->listConversations($request) -> ConversationList +
$client->unstable->conversations->listConversations($request) -> ConversationList
@@ -15858,7 +15972,7 @@ $client->conversations->list(
-
$client->unstable->conversations->createConversation($request) -> Message +
$client->unstable->conversations->createConversation($request) -> Message
@@ -15945,7 +16059,7 @@ $client->conversations->create(
-
$client->unstable->conversations->retrieveConversation($request) -> Conversation +
$client->unstable->conversations->retrieveConversation($request) -> Conversation
@@ -16030,7 +16144,7 @@ $client->unstable->conversations->retrieveConversation(
-
$client->unstable->conversations->updateConversation($request) -> Conversation +
$client->unstable->conversations->updateConversation($request) -> Conversation
@@ -16147,7 +16261,7 @@ $client->unstable->conversations->updateConversation(
-
$client->unstable->conversations->deleteConversation($request) -> ConversationDeleted +
$client->unstable->conversations->deleteConversation($request) -> ConversationDeleted
@@ -16205,7 +16319,7 @@ $client->unstable->conversations->deleteConversation(
-
$client->unstable->conversations->searchConversations($request) -> ConversationList +
$client->unstable->conversations->searchConversations($request) -> ConversationList
@@ -16364,7 +16478,7 @@ $client->unstable->conversations->searchConversations(
-
$client->unstable->conversations->replyConversation($request) -> Conversation +
$client->unstable->conversations->replyConversation($request) -> Conversation
@@ -16436,7 +16550,7 @@ $client->unstable->conversations->replyConversation(
-
$client->unstable->conversations->manageConversation($request) -> Conversation +
$client->unstable->conversations->manageConversation($request) -> Conversation
@@ -16510,7 +16624,7 @@ $client->unstable->conversations->manageConversation(
-
$client->unstable->conversations->attachContactToConversation($request) -> Conversation +
$client->unstable->conversations->attachContactToConversation($request) -> Conversation
@@ -16593,7 +16707,7 @@ $client->unstable->conversations->attachContactToConversation(
-
$client->unstable->conversations->detachContactFromConversation($request) -> Conversation +
$client->unstable->conversations->detachContactFromConversation($request) -> Conversation
@@ -16674,7 +16788,7 @@ $client->conversations->detachContactAsAdmin(
-
$client->unstable->conversations->redactConversation($request) -> Conversation +
$client->unstable->conversations->redactConversation($request) -> Conversation
@@ -16738,7 +16852,7 @@ $client->conversations->redactConversationPart(
-
$client->unstable->conversations->convertConversationToTicket($request) -> ?Ticket +
$client->unstable->conversations->convertConversationToTicket($request) -> ?Ticket
@@ -16814,7 +16928,7 @@ $client->unstable->conversations->convertConversationToTicket(
## Unstable CustomChannelEvents -
$client->unstable->customChannelEvents->notifyNewConversation($request) -> CustomChannelNotificationResponse +
$client->unstable->customChannelEvents->notifyNewConversation($request) -> CustomChannelNotificationResponse
@@ -16880,7 +16994,7 @@ $client->customChannelEvents->notifyNewConversation(
-
$client->unstable->customChannelEvents->notifyNewMessage($request) -> CustomChannelNotificationResponse +
$client->unstable->customChannelEvents->notifyNewMessage($request) -> CustomChannelNotificationResponse
@@ -16947,7 +17061,7 @@ $client->customChannelEvents->notifyNewMessage(
-
$client->unstable->customChannelEvents->notifyQuickReplySelected($request) -> CustomChannelNotificationResponse +
$client->unstable->customChannelEvents->notifyQuickReplySelected($request) -> CustomChannelNotificationResponse
@@ -17014,7 +17128,7 @@ $client->customChannelEvents->notifyQuickReplySelected(
-
$client->unstable->customChannelEvents->notifyAttributeCollected($request) -> CustomChannelNotificationResponse +
$client->unstable->customChannelEvents->notifyAttributeCollected($request) -> CustomChannelNotificationResponse
@@ -17085,7 +17199,7 @@ $client->customChannelEvents->notifyAttributeCollected(
## Custom Object Instances -
$client->unstable->customObjectInstances->getCustomObjectInstancesByExternalId($request) -> ?CustomObjectInstance +
$client->unstable->customObjectInstances->getCustomObjectInstancesByExternalId($request) -> ?CustomObjectInstance
@@ -17152,7 +17266,7 @@ $client->customObjectInstances->getCustomObjectInstancesByExternalId(
-
$client->unstable->customObjectInstances->createCustomObjectInstances($request) -> ?CustomObjectInstance +
$client->unstable->customObjectInstances->createCustomObjectInstances($request) -> ?CustomObjectInstance
@@ -17249,7 +17363,7 @@ $client->customObjectInstances->createCustomObjectInstances(
-
$client->unstable->customObjectInstances->deleteCustomObjectInstancesById($request) -> CustomObjectInstanceDeleted +
$client->unstable->customObjectInstances->deleteCustomObjectInstancesById($request) -> CustomObjectInstanceDeleted
@@ -17316,7 +17430,7 @@ $client->customObjectInstances->deleteCustomObjectInstancesById(
-
$client->unstable->customObjectInstances->getCustomObjectInstancesById($request) -> ?CustomObjectInstance +
$client->unstable->customObjectInstances->getCustomObjectInstancesById($request) -> ?CustomObjectInstance
@@ -17383,7 +17497,7 @@ $client->unstable->customObjectInstances->getCustomObjectInstancesById(
-
$client->unstable->customObjectInstances->deleteCustomObjectInstancesByExternalId($request) -> CustomObjectInstanceDeleted +
$client->unstable->customObjectInstances->deleteCustomObjectInstancesByExternalId($request) -> CustomObjectInstanceDeleted
@@ -17451,7 +17565,7 @@ $client->unstable->customObjectInstances->deleteCustomObjectInstancesByExternalI
## Data Attributes -
$client->unstable->dataAttributes->lisDataAttributes($request) -> DataAttributeList +
$client->unstable->dataAttributes->lisDataAttributes($request) -> DataAttributeList
@@ -17518,7 +17632,7 @@ $client->dataAttributes->list(
-
$client->unstable->dataAttributes->createDataAttribute($request) -> DataAttribute +
$client->unstable->dataAttributes->createDataAttribute($request) -> DataAttribute
@@ -17576,7 +17690,7 @@ $client->unstable->dataAttributes->createDataAttribute(
-
$client->unstable->dataAttributes->updateDataAttribute($request) -> DataAttribute +
$client->unstable->dataAttributes->updateDataAttribute($request) -> DataAttribute
@@ -17651,7 +17765,7 @@ $client->unstable->dataAttributes->updateDataAttribute(
## Data Events -
$client->unstable->dataEvents->lisDataEvents($request) -> DataEventSummary +
$client->unstable->dataEvents->lisDataEvents($request) -> DataEventSummary
@@ -17741,7 +17855,7 @@ $client->unstable->dataEvents->lisDataEvents(
-
$client->unstable->dataEvents->createDataEvent($request) +
$client->unstable->dataEvents->createDataEvent($request)
@@ -17840,7 +17954,7 @@ $client->unstable->dataEvents->createDataEvent(
-
$client->unstable->dataEvents->dataEventSummaries($request) +
$client->unstable->dataEvents->dataEventSummaries($request)
@@ -17906,7 +18020,7 @@ $client->events->summaries(
## Data Export -
$client->unstable->dataExport->createDataExport($request) -> DataExport +
$client->unstable->dataExport->createDataExport($request) -> DataExport
@@ -17987,7 +18101,7 @@ $client->dataExport->create(
-
$client->unstable->dataExport->getDataExport($request) -> DataExport +
$client->unstable->dataExport->getDataExport($request) -> DataExport
@@ -18049,7 +18163,7 @@ $client->dataExport->find(
-
$client->unstable->dataExport->cancelDataExport($request) -> DataExport +
$client->unstable->dataExport->cancelDataExport($request) -> DataExport
@@ -18107,7 +18221,7 @@ $client->dataExport->cancel(
-
$client->unstable->dataExport->downloadDataExport($request) +
$client->unstable->dataExport->downloadDataExport($request)
@@ -18172,7 +18286,7 @@ $client->dataExport->download(
## Jobs -
$client->unstable->jobs->status($request) -> Jobs +
$client->unstable->jobs->status($request) -> Jobs
@@ -18231,7 +18345,7 @@ $client->unstable->jobs->status(
## Macros -
$client->unstable->macros->listMacros($request) -> MacroList +
$client->unstable->macros->listMacros($request) -> MacroList
@@ -18319,7 +18433,7 @@ $client->unstable->macros->listMacros(
-
$client->unstable->macros->getMacro($request) -> ?Macro +
$client->unstable->macros->getMacro($request) -> ?Macro
@@ -18394,7 +18508,7 @@ $client->unstable->macros->getMacro(
## Messages -
$client->unstable->messages->createMessage($request) -> Message +
$client->unstable->messages->createMessage($request) -> Message
@@ -18467,7 +18581,7 @@ $client->unstable->messages->createMessage(
-
$client->unstable->messages->getWhatsAppMessageStatus($request) -> WhatsappMessageStatusList +
$client->unstable->messages->getWhatsAppMessageStatus($request) -> WhatsappMessageStatusList
@@ -18548,7 +18662,7 @@ $client->unstable->messages->getWhatsAppMessageStatus(
## News -
$client->unstable->news->listNewsItems() -> PaginatedResponse +
$client->unstable->news->listNewsItems() -> PaginatedResponse
@@ -18587,7 +18701,7 @@ $client->news->items->list();
-
$client->unstable->news->createNewsItem($request) -> NewsItem +
$client->unstable->news->createNewsItem($request) -> NewsItem
@@ -18664,7 +18778,7 @@ $client->news->items->create(
-
$client->unstable->news->retrieveNewsItem($request) -> NewsItem +
$client->unstable->news->retrieveNewsItem($request) -> NewsItem
@@ -18722,7 +18836,7 @@ $client->unstable->news->retrieveNewsItem(
-
$client->unstable->news->updateNewsItem($request) -> NewsItem +
$client->unstable->news->updateNewsItem($request) -> NewsItem
@@ -18783,7 +18897,7 @@ $client->unstable->news->updateNewsItem(
-
$client->unstable->news->deleteNewsItem($request) -> DeletedObject +
$client->unstable->news->deleteNewsItem($request) -> DeletedObject
@@ -18841,7 +18955,7 @@ $client->unstable->news->deleteNewsItem(
-
$client->unstable->news->listLiveNewsfeedItems($request) -> PaginatedResponse +
$client->unstable->news->listLiveNewsfeedItems($request) -> PaginatedResponse
@@ -18899,7 +19013,7 @@ $client->unstable->news->listLiveNewsfeedItems(
-
$client->unstable->news->listNewsfeeds() -> PaginatedResponse +
$client->unstable->news->listNewsfeeds() -> PaginatedResponse
@@ -18938,7 +19052,7 @@ $client->news->feeds->list();
-
$client->unstable->news->retrieveNewsfeed($request) -> Newsfeed +
$client->unstable->news->retrieveNewsfeed($request) -> Newsfeed
@@ -18997,7 +19111,7 @@ $client->unstable->news->retrieveNewsfeed(
## Segments -
$client->unstable->segments->listSegments($request) -> SegmentList +
$client->unstable->segments->listSegments($request) -> SegmentList
@@ -19055,7 +19169,7 @@ $client->segments->list(
-
$client->unstable->segments->retrieveSegment($request) -> Segment +
$client->unstable->segments->retrieveSegment($request) -> Segment
@@ -19114,7 +19228,7 @@ $client->unstable->segments->retrieveSegment(
## Switch -
$client->unstable->switch_->createPhoneSwitch($request) -> ?PhoneSwitch +
$client->unstable->switch_->createPhoneSwitch($request) -> ?PhoneSwitch
@@ -19176,7 +19290,7 @@ $client->unstable->switch->createPhoneSwitch(
## Calls -
$client->unstable->calls->listCalls($request) -> CallList +
$client->unstable->calls->listCalls($request) -> CallList
@@ -19243,7 +19357,7 @@ $client->calls->listCalls(
-
$client->unstable->calls->showCall($request) -> Call +
$client->unstable->calls->showCall($request) -> Call
@@ -19301,7 +19415,7 @@ $client->unstable->calls->showCall(
-
$client->unstable->calls->showCallRecording($request) +
$client->unstable->calls->showCallRecording($request)
@@ -19359,7 +19473,7 @@ $client->unstable->calls->showCallRecording(
-
$client->unstable->calls->showCallTranscript($request) -> string +
$client->unstable->calls->showCallTranscript($request) -> string
@@ -19417,7 +19531,7 @@ $client->unstable->calls->showCallTranscript(
-
$client->unstable->calls->listCallsWithTranscripts($request) -> ListCallsWithTranscriptsResponse +
$client->unstable->calls->listCallsWithTranscripts($request) -> ListCallsWithTranscriptsResponse
@@ -19479,7 +19593,7 @@ $client->calls->listCallsWithTranscripts(
-
$client->unstable->calls->registerFinVoiceCall($request) -> AiCallResponse +
$client->unstable->calls->registerFinVoiceCall($request) -> AiCallResponse
@@ -19544,7 +19658,7 @@ $client->unstable->calls->registerFinVoiceCall(
-
$client->unstable->calls->collectFinVoiceCallById($request) -> AiCallResponse +
$client->unstable->calls->collectFinVoiceCallById($request) -> AiCallResponse
@@ -19602,7 +19716,7 @@ $client->unstable->calls->collectFinVoiceCallById(
-
$client->unstable->calls->collectFinVoiceCallByExternalId($request) -> AiCallResponse +
$client->unstable->calls->collectFinVoiceCallByExternalId($request) -> AiCallResponse
@@ -19660,7 +19774,7 @@ $client->unstable->calls->collectFinVoiceCallByExternalId(
-
$client->unstable->calls->collectFinVoiceCallByPhoneNumber($request) -> Error +
$client->unstable->calls->collectFinVoiceCallByPhoneNumber($request) -> Error
@@ -19721,7 +19835,7 @@ $client->unstable->calls->collectFinVoiceCallByPhoneNumber(
## Teams -
$client->unstable->teams->listTeams() -> TeamList +
$client->unstable->teams->listTeams() -> TeamList
@@ -19760,7 +19874,7 @@ $client->teams->list();
-
$client->unstable->teams->retrieveTeam($request) -> Team +
$client->unstable->teams->retrieveTeam($request) -> Team
@@ -19819,7 +19933,7 @@ $client->unstable->teams->retrieveTeam(
## Ticket States -
$client->unstable->ticketStates->listTicketStates() -> TicketStateList +
$client->unstable->ticketStates->listTicketStates() -> TicketStateList
@@ -19859,7 +19973,7 @@ $client->ticketStates->listTicketStates();
## Ticket Type Attributes -
$client->unstable->ticketTypeAttributes->createTicketTypeAttribute($request) -> ?TicketTypeAttribute +
$client->unstable->ticketTypeAttributes->createTicketTypeAttribute($request) -> ?TicketTypeAttribute
@@ -20001,7 +20115,7 @@ $client->ticketTypes->attributes->create(
-
$client->unstable->ticketTypeAttributes->updateTicketTypeAttribute($request) -> ?TicketTypeAttribute +
$client->unstable->ticketTypeAttributes->updateTicketTypeAttribute($request) -> ?TicketTypeAttribute
@@ -20150,7 +20264,7 @@ $client->unstable->ticketTypeAttributes->updateTicketTypeAttribute(
## Ticket Types -
$client->unstable->ticketTypes->listTicketTypes() -> TicketTypeList +
$client->unstable->ticketTypes->listTicketTypes() -> TicketTypeList
@@ -20189,7 +20303,7 @@ $client->ticketTypes->list();
-
$client->unstable->ticketTypes->createTicketType($request) -> ?TicketType +
$client->unstable->ticketTypes->createTicketType($request) -> ?TicketType
@@ -20251,7 +20365,7 @@ $client->unstable->ticketTypes->createTicketType(
-
$client->unstable->ticketTypes->getTicketType($request) -> ?TicketType +
$client->unstable->ticketTypes->getTicketType($request) -> ?TicketType
@@ -20310,7 +20424,7 @@ $client->unstable->ticketTypes->getTicketType(
## Tickets -
$client->unstable->tickets->replyTicket($request) -> TicketReply +
$client->unstable->tickets->replyTicket($request) -> TicketReply
@@ -20382,7 +20496,7 @@ $client->unstable->tickets->replyTicket(
-
$client->unstable->tickets->enqueueCreateTicket($request) -> Jobs +
$client->unstable->tickets->enqueueCreateTicket($request) -> Jobs
@@ -20445,7 +20559,7 @@ $client->tickets->enqueueCreateTicket(
-
$client->unstable->tickets->getTicket($request) -> ?Ticket +
$client->unstable->tickets->getTicket($request) -> ?Ticket
@@ -20503,7 +20617,7 @@ $client->unstable->tickets->getTicket(
-
$client->unstable->tickets->updateTicket($request) -> ?Ticket +
$client->unstable->tickets->updateTicket($request) -> ?Ticket
@@ -20634,7 +20748,7 @@ $client->unstable->tickets->updateTicket(
-
$client->unstable->tickets->deleteTicket($request) -> DeleteTicketResponse +
$client->unstable->tickets->deleteTicket($request) -> DeleteTicketResponse
@@ -20692,7 +20806,7 @@ $client->unstable->tickets->deleteTicket(
-
$client->unstable->tickets->searchTickets($request) -> TicketList +
$client->unstable->tickets->searchTickets($request) -> TicketList
@@ -20822,7 +20936,7 @@ $client->unstable->tickets->searchTickets(
## Visitors -
$client->unstable->visitors->retrieveVisitorWithUserId($request) -> ?Visitor +
$client->unstable->visitors->retrieveVisitorWithUserId($request) -> ?Visitor
@@ -20880,7 +20994,7 @@ $client->visitors->find(
-
$client->unstable->visitors->updateVisitor($request) -> ?Visitor +
$client->unstable->visitors->updateVisitor($request) -> ?Visitor
@@ -20943,7 +21057,7 @@ $client->visitors->update(
-
$client->unstable->visitors->convertVisitor($request) -> Contact +
$client->unstable->visitors->convertVisitor($request) -> Contact
@@ -21028,7 +21142,7 @@ $client->unstable->visitors->convertVisitor(
## Brands -
$client->unstable->brands->listBrands() -> BrandList +
$client->unstable->brands->listBrands() -> BrandList
@@ -21068,7 +21182,7 @@ $client->unstable->brands->listBrands();
-
$client->unstable->brands->retrieveBrand($request) -> Brand +
$client->unstable->brands->retrieveBrand($request) -> Brand
@@ -21127,7 +21241,7 @@ $client->unstable->brands->retrieveBrand(
## Emails -
$client->unstable->emails->listEmails() -> EmailList +
$client->unstable->emails->listEmails() -> EmailList
@@ -21166,7 +21280,7 @@ $client->unstable->emails->listEmails();
-
$client->unstable->emails->retrieveEmail($request) -> EmailSetting +
$client->unstable->emails->retrieveEmail($request) -> EmailSetting
diff --git a/src/IntercomClient.php b/src/IntercomClient.php index 555e479..f6f374c 100644 --- a/src/IntercomClient.php +++ b/src/IntercomClient.php @@ -10,6 +10,7 @@ use Intercom\DataExport\DataExportClient; use Intercom\HelpCenters\HelpCentersClient; use Intercom\InternalArticles\InternalArticlesClient; +use Intercom\IpAllowlist\IpAllowlistClient; use Intercom\Companies\CompaniesClient; use Intercom\Contacts\ContactsClient; use Intercom\Notes\NotesClient; @@ -78,6 +79,11 @@ class IntercomClient */ public InternalArticlesClient $internalArticles; + /** + * @var IpAllowlistClient $ipAllowlist + */ + public IpAllowlistClient $ipAllowlist; + /** * @var CompaniesClient $companies */ @@ -223,8 +229,8 @@ public function __construct( 'Authorization' => "Bearer $token", 'X-Fern-Language' => 'PHP', 'X-Fern-SDK-Name' => 'Intercom', - 'X-Fern-SDK-Version' => '6.0.0', - 'User-Agent' => 'intercom/intercom-php/6.0.0', + 'X-Fern-SDK-Version' => '0.0.464', + 'User-Agent' => 'intercom/intercom-php/0.0.464', 'Intercom-Version' => '2.14', ]; @@ -247,6 +253,7 @@ public function __construct( $this->dataExport = new DataExportClient($this->client, $this->options); $this->helpCenters = new HelpCentersClient($this->client, $this->options); $this->internalArticles = new InternalArticlesClient($this->client, $this->options); + $this->ipAllowlist = new IpAllowlistClient($this->client, $this->options); $this->companies = new CompaniesClient($this->client, $this->options); $this->contacts = new ContactsClient($this->client, $this->options); $this->notes = new NotesClient($this->client, $this->options); diff --git a/src/IpAllowlist/IpAllowlistClient.php b/src/IpAllowlist/IpAllowlistClient.php new file mode 100644 index 0000000..ae549af --- /dev/null +++ b/src/IpAllowlist/IpAllowlistClient.php @@ -0,0 +1,166 @@ +, + * } $options @phpstan-ignore-next-line Property is used in endpoint methods via HttpEndpointGenerator + */ + private array $options; + + /** + * @var RawClient $client + */ + private RawClient $client; + + /** + * @param RawClient $client + * @param ?array{ + * baseUrl?: string, + * client?: ClientInterface, + * maxRetries?: int, + * timeout?: float, + * headers?: array, + * } $options + */ + public function __construct( + RawClient $client, + ?array $options = null, + ) { + $this->client = $client; + $this->options = $options ?? []; + } + + /** + * Retrieve the current IP allowlist configuration for the workspace. + * + * @param ?array{ + * baseUrl?: string, + * maxRetries?: int, + * timeout?: float, + * headers?: array, + * queryParameters?: array, + * bodyProperties?: array, + * } $options + * @return IpAllowlist + * @throws IntercomException + * @throws IntercomApiException + */ + public function getIpAllowlist(?array $options = null): IpAllowlist + { + $options = array_merge($this->options, $options ?? []); + try { + $response = $this->client->sendRequest( + new JsonApiRequest( + baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::UsProduction->value, + path: "ip_allowlist", + method: HttpMethod::GET, + ), + $options, + ); + $statusCode = $response->getStatusCode(); + if ($statusCode >= 200 && $statusCode < 400) { + $json = $response->getBody()->getContents(); + return IpAllowlist::fromJson($json); + } + } catch (JsonException $e) { + throw new IntercomException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e); + } catch (RequestException $e) { + $response = $e->getResponse(); + if ($response === null) { + throw new IntercomException(message: $e->getMessage(), previous: $e); + } + throw new IntercomApiException( + message: "API request failed", + statusCode: $response->getStatusCode(), + body: $response->getBody()->getContents(), + ); + } catch (ClientExceptionInterface $e) { + throw new IntercomException(message: $e->getMessage(), previous: $e); + } + throw new IntercomApiException( + message: 'API request failed', + statusCode: $statusCode, + body: $response->getBody()->getContents(), + ); + } + + /** + * Update the IP allowlist configuration for the workspace. + * + * {% admonition type="warning" name="Lockout Protection" %} + * The API will reject updates that would lock out the caller's IP address. Ensure your current IP is included in the allowlist when enabling the feature. + * {% /admonition %} + * + * @param IpAllowlist $request + * @param ?array{ + * baseUrl?: string, + * maxRetries?: int, + * timeout?: float, + * headers?: array, + * queryParameters?: array, + * bodyProperties?: array, + * } $options + * @return IpAllowlist + * @throws IntercomException + * @throws IntercomApiException + */ + public function updateIpAllowlist(IpAllowlist $request, ?array $options = null): IpAllowlist + { + $options = array_merge($this->options, $options ?? []); + try { + $response = $this->client->sendRequest( + new JsonApiRequest( + baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::UsProduction->value, + path: "ip_allowlist", + method: HttpMethod::PUT, + body: $request, + ), + $options, + ); + $statusCode = $response->getStatusCode(); + if ($statusCode >= 200 && $statusCode < 400) { + $json = $response->getBody()->getContents(); + return IpAllowlist::fromJson($json); + } + } catch (JsonException $e) { + throw new IntercomException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e); + } catch (RequestException $e) { + $response = $e->getResponse(); + if ($response === null) { + throw new IntercomException(message: $e->getMessage(), previous: $e); + } + throw new IntercomApiException( + message: "API request failed", + statusCode: $response->getStatusCode(), + body: $response->getBody()->getContents(), + ); + } catch (ClientExceptionInterface $e) { + throw new IntercomException(message: $e->getMessage(), previous: $e); + } + throw new IntercomApiException( + message: 'API request failed', + statusCode: $statusCode, + body: $response->getBody()->getContents(), + ); + } +} diff --git a/src/Types/ActivityLogActivityType.php b/src/Types/ActivityLogActivityType.php index fbb97d1..5b715a2 100644 --- a/src/Types/ActivityLogActivityType.php +++ b/src/Types/ActivityLogActivityType.php @@ -58,7 +58,7 @@ enum ActivityLogActivityType: string case InboxAccessChange = "inbox_access_change"; case MacroCreation = "macro_creation"; case MacroDeletion = "macro_deletion"; - case MacroUpdated = "macro_updated"; + case MacroUpdate = "macro_update"; case MaliciousDomainsSettingChange = "malicious_domains_setting_change"; case MessageDeletion = "message_deletion"; case MessageStateChange = "message_state_change"; @@ -80,6 +80,11 @@ enum ActivityLogActivityType: string case SeatChange = "seat_change"; case SeatRevoke = "seat_revoke"; case SecuritySettingsChange = "security_settings_change"; + case SeriesCreation = "series_creation"; + case SeriesDeletion = "series_deletion"; + case SeriesSettingsUpdate = "series_settings_update"; + case SeriesStatusChange = "series_status_change"; + case SeriesUpdate = "series_update"; case StripInboundEmailLinksChange = "strip_inbound_email_links_change"; case TemporaryExpectationChange = "temporary_expectation_change"; case TeamAssignmentLimitChange = "team_assignment_limit_change"; diff --git a/src/Types/IpAllowlist.php b/src/Types/IpAllowlist.php new file mode 100644 index 0000000..9a3e479 --- /dev/null +++ b/src/Types/IpAllowlist.php @@ -0,0 +1,110 @@ + $ipAllowlist + */ + #[JsonProperty('ip_allowlist'), ArrayType(['string'])] + private ?array $ipAllowlist; + + /** + * @param array{ + * type?: ?string, + * enabled?: ?bool, + * ipAllowlist?: ?array, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->type = $values['type'] ?? null; + $this->enabled = $values['enabled'] ?? null; + $this->ipAllowlist = $values['ipAllowlist'] ?? null; + } + + /** + * @return ?string + */ + public function getType(): ?string + { + return $this->type; + } + + /** + * @param ?string $value + */ + public function setType(?string $value = null): self + { + $this->type = $value; + return $this; + } + + /** + * @return ?bool + */ + public function getEnabled(): ?bool + { + return $this->enabled; + } + + /** + * @param ?bool $value + */ + public function setEnabled(?bool $value = null): self + { + $this->enabled = $value; + return $this; + } + + /** + * @return ?array + */ + public function getIpAllowlist(): ?array + { + return $this->ipAllowlist; + } + + /** + * @param ?array $value + */ + public function setIpAllowlist(?array $value = null): self + { + $this->ipAllowlist = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Contacts/Requests/UpdateContactRequest.php b/src/Unstable/Contacts/Requests/UpdateContactRequest.php index f3b1e69..67c6ecf 100644 --- a/src/Unstable/Contacts/Requests/UpdateContactRequest.php +++ b/src/Unstable/Contacts/Requests/UpdateContactRequest.php @@ -73,6 +73,12 @@ class UpdateContactRequest extends JsonSerializableType #[JsonProperty('unsubscribed_from_emails')] private ?bool $unsubscribedFromEmails; + /** + * @var ?string $languageOverride A preferred language setting for the contact, used by Intercom as the language of Fin and the Messenger even if their browser has a different setting. Supports ISO 639-1 two-letter language codes. If an unsupported code is supplied, the field will be set to null. + */ + #[JsonProperty('language_override')] + private ?string $languageOverride; + /** * @var ?array $customAttributes The custom attributes which are set for the contact */ @@ -92,6 +98,7 @@ class UpdateContactRequest extends JsonSerializableType * lastSeenAt?: ?int, * ownerId?: ?int, * unsubscribedFromEmails?: ?bool, + * languageOverride?: ?string, * customAttributes?: ?array, * } $values */ @@ -109,6 +116,7 @@ public function __construct( $this->lastSeenAt = $values['lastSeenAt'] ?? null; $this->ownerId = $values['ownerId'] ?? null; $this->unsubscribedFromEmails = $values['unsubscribedFromEmails'] ?? null; + $this->languageOverride = $values['languageOverride'] ?? null; $this->customAttributes = $values['customAttributes'] ?? null; } @@ -299,6 +307,23 @@ public function setUnsubscribedFromEmails(?bool $value = null): self return $this; } + /** + * @return ?string + */ + public function getLanguageOverride(): ?string + { + return $this->languageOverride; + } + + /** + * @param ?string $value + */ + public function setLanguageOverride(?string $value = null): self + { + $this->languageOverride = $value; + return $this; + } + /** * @return ?array */ diff --git a/src/Unstable/Contacts/Traits/Contact.php b/src/Unstable/Contacts/Traits/Contact.php index f1d043a..1fb501a 100644 --- a/src/Unstable/Contacts/Traits/Contact.php +++ b/src/Unstable/Contacts/Traits/Contact.php @@ -196,7 +196,7 @@ trait Contact private ?int $lastEmailClickedAt; /** - * @var ?string $languageOverride A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change. + * @var ?string $languageOverride A preferred language setting for the contact, used by Intercom as the language of Fin and the Messenger even if their browser has a different setting. Supports ISO 639-1 two-letter language codes. If an unsupported code is supplied, the field will be set to null. */ #[JsonProperty('language_override')] private ?string $languageOverride; diff --git a/src/Unstable/Contacts/Types/Contact.php b/src/Unstable/Contacts/Types/Contact.php index 198b775..5c58ec2 100644 --- a/src/Unstable/Contacts/Types/Contact.php +++ b/src/Unstable/Contacts/Types/Contact.php @@ -149,7 +149,7 @@ class Contact extends JsonSerializableType private ?int $lastEmailClickedAt; /** - * @var ?string $languageOverride A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change. + * @var ?string $languageOverride A preferred language setting for the contact, used by Intercom as the language of Fin and the Messenger even if their browser has a different setting. Supports ISO 639-1 two-letter language codes. If an unsupported code is supplied, the field will be set to null. */ #[JsonProperty('language_override')] private ?string $languageOverride; diff --git a/src/Unstable/Conversations/Types/Conversation.php b/src/Unstable/Conversations/Types/Conversation.php index 39f284b..55ddc9e 100644 --- a/src/Unstable/Conversations/Types/Conversation.php +++ b/src/Unstable/Conversations/Types/Conversation.php @@ -4,6 +4,7 @@ use Intercom\Core\Json\JsonSerializableType; use Intercom\Core\Json\JsonProperty; +use Intercom\Unstable\Companies\Types\Company; use Intercom\Unstable\Types\Tags; use Intercom\Unstable\Types\ConversationRating; use Intercom\Unstable\Types\ConversationSource; @@ -109,6 +110,12 @@ class Conversation extends JsonSerializableType #[JsonProperty('company_id')] private ?string $companyId; + /** + * @var ?Company $company The company associated with the conversation. + */ + #[JsonProperty('company')] + private ?Company $company; + /** * @var ?Tags $tags */ @@ -208,6 +215,7 @@ class Conversation extends JsonSerializableType * adminAssigneeId?: ?int, * teamAssigneeId?: ?string, * companyId?: ?string, + * company?: ?Company, * tags?: ?Tags, * conversationRating?: ?ConversationRating, * source?: ?ConversationSource, @@ -245,6 +253,7 @@ public function __construct( $this->adminAssigneeId = $values['adminAssigneeId'] ?? null; $this->teamAssigneeId = $values['teamAssigneeId'] ?? null; $this->companyId = $values['companyId'] ?? null; + $this->company = $values['company'] ?? null; $this->tags = $values['tags'] ?? null; $this->conversationRating = $values['conversationRating'] ?? null; $this->source = $values['source'] ?? null; @@ -498,6 +507,23 @@ public function setCompanyId(?string $value = null): self return $this; } + /** + * @return ?Company + */ + public function getCompany(): ?Company + { + return $this->company; + } + + /** + * @param ?Company $value + */ + public function setCompany(?Company $value = null): self + { + $this->company = $value; + return $this; + } + /** * @return ?Tags */ diff --git a/src/Unstable/Types/ConversationAttributeUpdatedByAdminValue.php b/src/Unstable/Types/ConversationAttributeUpdatedByAdminValue.php index 8ef23c0..a0c5d7e 100644 --- a/src/Unstable/Types/ConversationAttributeUpdatedByAdminValue.php +++ b/src/Unstable/Types/ConversationAttributeUpdatedByAdminValue.php @@ -8,20 +8,28 @@ class ConversationAttributeUpdatedByAdminValue extends JsonSerializableType { /** - * @var ?string $name Value of the CDA updated + * @var ?string $name Current value of the CDA updated */ #[JsonProperty('name')] private ?string $name; + /** + * @var ?string $previous Previous value of the CDA + */ + #[JsonProperty('previous')] + private ?string $previous; + /** * @param array{ * name?: ?string, + * previous?: ?string, * } $values */ public function __construct( array $values = [], ) { $this->name = $values['name'] ?? null; + $this->previous = $values['previous'] ?? null; } /** @@ -41,6 +49,23 @@ public function setName(?string $value = null): self return $this; } + /** + * @return ?string + */ + public function getPrevious(): ?string + { + return $this->previous; + } + + /** + * @param ?string $value + */ + public function setPrevious(?string $value = null): self + { + $this->previous = $value; + return $this; + } + /** * @return string */ diff --git a/src/Unstable/Types/ConversationAttributeUpdatedByUser.php b/src/Unstable/Types/ConversationAttributeUpdatedByUser.php new file mode 100644 index 0000000..e8d6d07 --- /dev/null +++ b/src/Unstable/Types/ConversationAttributeUpdatedByUser.php @@ -0,0 +1,79 @@ +conversation_attribute_updated_by_user. + */ +class ConversationAttributeUpdatedByUser extends JsonSerializableType +{ + /** + * @var ?ConversationAttributeUpdatedByUserAttribute $attribute + */ + #[JsonProperty('attribute')] + private ?ConversationAttributeUpdatedByUserAttribute $attribute; + + /** + * @var ?ConversationAttributeUpdatedByUserValue $value + */ + #[JsonProperty('value')] + private ?ConversationAttributeUpdatedByUserValue $value; + + /** + * @param array{ + * attribute?: ?ConversationAttributeUpdatedByUserAttribute, + * value?: ?ConversationAttributeUpdatedByUserValue, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->attribute = $values['attribute'] ?? null; + $this->value = $values['value'] ?? null; + } + + /** + * @return ?ConversationAttributeUpdatedByUserAttribute + */ + public function getAttribute(): ?ConversationAttributeUpdatedByUserAttribute + { + return $this->attribute; + } + + /** + * @param ?ConversationAttributeUpdatedByUserAttribute $value + */ + public function setAttribute(?ConversationAttributeUpdatedByUserAttribute $value = null): self + { + $this->attribute = $value; + return $this; + } + + /** + * @return ?ConversationAttributeUpdatedByUserValue + */ + public function getValue(): ?ConversationAttributeUpdatedByUserValue + { + return $this->value; + } + + /** + * @param ?ConversationAttributeUpdatedByUserValue $value + */ + public function setValue(?ConversationAttributeUpdatedByUserValue $value = null): self + { + $this->value = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationAttributeUpdatedByUserAttribute.php b/src/Unstable/Types/ConversationAttributeUpdatedByUserAttribute.php new file mode 100644 index 0000000..490691d --- /dev/null +++ b/src/Unstable/Types/ConversationAttributeUpdatedByUserAttribute.php @@ -0,0 +1,51 @@ +name = $values['name'] ?? null; + } + + /** + * @return ?string + */ + public function getName(): ?string + { + return $this->name; + } + + /** + * @param ?string $value + */ + public function setName(?string $value = null): self + { + $this->name = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationAttributeUpdatedByUserValue.php b/src/Unstable/Types/ConversationAttributeUpdatedByUserValue.php new file mode 100644 index 0000000..fc89171 --- /dev/null +++ b/src/Unstable/Types/ConversationAttributeUpdatedByUserValue.php @@ -0,0 +1,76 @@ +name = $values['name'] ?? null; + $this->previous = $values['previous'] ?? null; + } + + /** + * @return ?string + */ + public function getName(): ?string + { + return $this->name; + } + + /** + * @param ?string $value + */ + public function setName(?string $value = null): self + { + $this->name = $value; + return $this; + } + + /** + * @return ?string + */ + public function getPrevious(): ?string + { + return $this->previous; + } + + /** + * @param ?string $value + */ + public function setPrevious(?string $value = null): self + { + $this->previous = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationPart.php b/src/Unstable/Types/ConversationPart.php index 75f39a3..6be10a4 100644 --- a/src/Unstable/Types/ConversationPart.php +++ b/src/Unstable/Types/ConversationPart.php @@ -113,13 +113,23 @@ class ConversationPart extends JsonSerializableType * @var ( * ConversationAttributeUpdatedByWorkflow * |ConversationAttributeUpdatedByAdmin + * |ConversationAttributeUpdatedByUser * |CustomActionStarted * |CustomActionFinished * |OperatorWorkflowEvent + * |ConversationTagsUpdated + * |Snoozed + * |PriorityChanged + * |ConversationSlaAppliedByRule + * |ConversationSlaAppliedByWorkflow + * |ConversationSlaTargetMissed + * |ConversationSlaPaused + * |ConversationSlaUnpaused + * |ConversationSlaRemoved * )|null $eventDetails */ - #[JsonProperty('event_details'), Union(ConversationAttributeUpdatedByWorkflow::class, ConversationAttributeUpdatedByAdmin::class, CustomActionStarted::class, CustomActionFinished::class, OperatorWorkflowEvent::class, 'null')] - private ConversationAttributeUpdatedByWorkflow|ConversationAttributeUpdatedByAdmin|CustomActionStarted|CustomActionFinished|OperatorWorkflowEvent|null $eventDetails; + #[JsonProperty('event_details'), Union(ConversationAttributeUpdatedByWorkflow::class, ConversationAttributeUpdatedByAdmin::class, ConversationAttributeUpdatedByUser::class, CustomActionStarted::class, CustomActionFinished::class, OperatorWorkflowEvent::class, ConversationTagsUpdated::class, Snoozed::class, PriorityChanged::class, ConversationSlaAppliedByRule::class, ConversationSlaAppliedByWorkflow::class, ConversationSlaTargetMissed::class, ConversationSlaPaused::class, ConversationSlaUnpaused::class, ConversationSlaRemoved::class, 'null')] + private ConversationAttributeUpdatedByWorkflow|ConversationAttributeUpdatedByAdmin|ConversationAttributeUpdatedByUser|CustomActionStarted|CustomActionFinished|OperatorWorkflowEvent|ConversationTagsUpdated|Snoozed|PriorityChanged|ConversationSlaAppliedByRule|ConversationSlaAppliedByWorkflow|ConversationSlaTargetMissed|ConversationSlaPaused|ConversationSlaUnpaused|ConversationSlaRemoved|null $eventDetails; /** * @var ?string $appPackageCode The app package code if this part was created via API. null if the part was not created via API. @@ -148,9 +158,19 @@ class ConversationPart extends JsonSerializableType * eventDetails?: ( * ConversationAttributeUpdatedByWorkflow * |ConversationAttributeUpdatedByAdmin + * |ConversationAttributeUpdatedByUser * |CustomActionStarted * |CustomActionFinished * |OperatorWorkflowEvent + * |ConversationTagsUpdated + * |Snoozed + * |PriorityChanged + * |ConversationSlaAppliedByRule + * |ConversationSlaAppliedByWorkflow + * |ConversationSlaTargetMissed + * |ConversationSlaPaused + * |ConversationSlaUnpaused + * |ConversationSlaRemoved * )|null, * appPackageCode?: ?string, * } $values @@ -454,12 +474,22 @@ public function setTags(?array $value = null): self * @return ( * ConversationAttributeUpdatedByWorkflow * |ConversationAttributeUpdatedByAdmin + * |ConversationAttributeUpdatedByUser * |CustomActionStarted * |CustomActionFinished * |OperatorWorkflowEvent + * |ConversationTagsUpdated + * |Snoozed + * |PriorityChanged + * |ConversationSlaAppliedByRule + * |ConversationSlaAppliedByWorkflow + * |ConversationSlaTargetMissed + * |ConversationSlaPaused + * |ConversationSlaUnpaused + * |ConversationSlaRemoved * )|null */ - public function getEventDetails(): ConversationAttributeUpdatedByWorkflow|ConversationAttributeUpdatedByAdmin|CustomActionStarted|CustomActionFinished|OperatorWorkflowEvent|null + public function getEventDetails(): ConversationAttributeUpdatedByWorkflow|ConversationAttributeUpdatedByAdmin|ConversationAttributeUpdatedByUser|CustomActionStarted|CustomActionFinished|OperatorWorkflowEvent|ConversationTagsUpdated|Snoozed|PriorityChanged|ConversationSlaAppliedByRule|ConversationSlaAppliedByWorkflow|ConversationSlaTargetMissed|ConversationSlaPaused|ConversationSlaUnpaused|ConversationSlaRemoved|null { return $this->eventDetails; } @@ -468,12 +498,22 @@ public function getEventDetails(): ConversationAttributeUpdatedByWorkflow|Conver * @param ( * ConversationAttributeUpdatedByWorkflow * |ConversationAttributeUpdatedByAdmin + * |ConversationAttributeUpdatedByUser * |CustomActionStarted * |CustomActionFinished * |OperatorWorkflowEvent + * |ConversationTagsUpdated + * |Snoozed + * |PriorityChanged + * |ConversationSlaAppliedByRule + * |ConversationSlaAppliedByWorkflow + * |ConversationSlaTargetMissed + * |ConversationSlaPaused + * |ConversationSlaUnpaused + * |ConversationSlaRemoved * )|null $value */ - public function setEventDetails(ConversationAttributeUpdatedByWorkflow|ConversationAttributeUpdatedByAdmin|CustomActionStarted|CustomActionFinished|OperatorWorkflowEvent|null $value = null): self + public function setEventDetails(ConversationAttributeUpdatedByWorkflow|ConversationAttributeUpdatedByAdmin|ConversationAttributeUpdatedByUser|CustomActionStarted|CustomActionFinished|OperatorWorkflowEvent|ConversationTagsUpdated|Snoozed|PriorityChanged|ConversationSlaAppliedByRule|ConversationSlaAppliedByWorkflow|ConversationSlaTargetMissed|ConversationSlaPaused|ConversationSlaUnpaused|ConversationSlaRemoved|null $value = null): self { $this->eventDetails = $value; return $this; diff --git a/src/Unstable/Types/ConversationSlaAppliedByRule.php b/src/Unstable/Types/ConversationSlaAppliedByRule.php new file mode 100644 index 0000000..8781cc4 --- /dev/null +++ b/src/Unstable/Types/ConversationSlaAppliedByRule.php @@ -0,0 +1,79 @@ +conversation_sla_applied_by_rule. + */ +class ConversationSlaAppliedByRule extends JsonSerializableType +{ + /** + * @var ?string $slaName Name of the SLA that was applied + */ + #[JsonProperty('sla_name')] + private ?string $slaName; + + /** + * @var ?ConversationSlaAppliedByRuleSlaDefinition $slaDefinition Target times configured for the SLA (in seconds) + */ + #[JsonProperty('sla_definition')] + private ?ConversationSlaAppliedByRuleSlaDefinition $slaDefinition; + + /** + * @param array{ + * slaName?: ?string, + * slaDefinition?: ?ConversationSlaAppliedByRuleSlaDefinition, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->slaName = $values['slaName'] ?? null; + $this->slaDefinition = $values['slaDefinition'] ?? null; + } + + /** + * @return ?string + */ + public function getSlaName(): ?string + { + return $this->slaName; + } + + /** + * @param ?string $value + */ + public function setSlaName(?string $value = null): self + { + $this->slaName = $value; + return $this; + } + + /** + * @return ?ConversationSlaAppliedByRuleSlaDefinition + */ + public function getSlaDefinition(): ?ConversationSlaAppliedByRuleSlaDefinition + { + return $this->slaDefinition; + } + + /** + * @param ?ConversationSlaAppliedByRuleSlaDefinition $value + */ + public function setSlaDefinition(?ConversationSlaAppliedByRuleSlaDefinition $value = null): self + { + $this->slaDefinition = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationSlaAppliedByRuleSlaDefinition.php b/src/Unstable/Types/ConversationSlaAppliedByRuleSlaDefinition.php new file mode 100644 index 0000000..b5730c7 --- /dev/null +++ b/src/Unstable/Types/ConversationSlaAppliedByRuleSlaDefinition.php @@ -0,0 +1,129 @@ +firstReplyTime = $values['firstReplyTime'] ?? null; + $this->nextReplyTime = $values['nextReplyTime'] ?? null; + $this->resolutionTime = $values['resolutionTime'] ?? null; + $this->timeToClose = $values['timeToClose'] ?? null; + } + + /** + * @return ?int + */ + public function getFirstReplyTime(): ?int + { + return $this->firstReplyTime; + } + + /** + * @param ?int $value + */ + public function setFirstReplyTime(?int $value = null): self + { + $this->firstReplyTime = $value; + return $this; + } + + /** + * @return ?int + */ + public function getNextReplyTime(): ?int + { + return $this->nextReplyTime; + } + + /** + * @param ?int $value + */ + public function setNextReplyTime(?int $value = null): self + { + $this->nextReplyTime = $value; + return $this; + } + + /** + * @return ?int + */ + public function getResolutionTime(): ?int + { + return $this->resolutionTime; + } + + /** + * @param ?int $value + */ + public function setResolutionTime(?int $value = null): self + { + $this->resolutionTime = $value; + return $this; + } + + /** + * @return ?int + */ + public function getTimeToClose(): ?int + { + return $this->timeToClose; + } + + /** + * @param ?int $value + */ + public function setTimeToClose(?int $value = null): self + { + $this->timeToClose = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationSlaAppliedByWorkflow.php b/src/Unstable/Types/ConversationSlaAppliedByWorkflow.php new file mode 100644 index 0000000..ed4356b --- /dev/null +++ b/src/Unstable/Types/ConversationSlaAppliedByWorkflow.php @@ -0,0 +1,79 @@ +conversation_sla_applied_by_workflow. + */ +class ConversationSlaAppliedByWorkflow extends JsonSerializableType +{ + /** + * @var ?string $slaName Name of the SLA that was applied + */ + #[JsonProperty('sla_name')] + private ?string $slaName; + + /** + * @var ?ConversationSlaAppliedByWorkflowSlaDefinition $slaDefinition Target times configured for the SLA (in seconds) + */ + #[JsonProperty('sla_definition')] + private ?ConversationSlaAppliedByWorkflowSlaDefinition $slaDefinition; + + /** + * @param array{ + * slaName?: ?string, + * slaDefinition?: ?ConversationSlaAppliedByWorkflowSlaDefinition, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->slaName = $values['slaName'] ?? null; + $this->slaDefinition = $values['slaDefinition'] ?? null; + } + + /** + * @return ?string + */ + public function getSlaName(): ?string + { + return $this->slaName; + } + + /** + * @param ?string $value + */ + public function setSlaName(?string $value = null): self + { + $this->slaName = $value; + return $this; + } + + /** + * @return ?ConversationSlaAppliedByWorkflowSlaDefinition + */ + public function getSlaDefinition(): ?ConversationSlaAppliedByWorkflowSlaDefinition + { + return $this->slaDefinition; + } + + /** + * @param ?ConversationSlaAppliedByWorkflowSlaDefinition $value + */ + public function setSlaDefinition(?ConversationSlaAppliedByWorkflowSlaDefinition $value = null): self + { + $this->slaDefinition = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationSlaAppliedByWorkflowSlaDefinition.php b/src/Unstable/Types/ConversationSlaAppliedByWorkflowSlaDefinition.php new file mode 100644 index 0000000..14336c7 --- /dev/null +++ b/src/Unstable/Types/ConversationSlaAppliedByWorkflowSlaDefinition.php @@ -0,0 +1,129 @@ +firstReplyTime = $values['firstReplyTime'] ?? null; + $this->nextReplyTime = $values['nextReplyTime'] ?? null; + $this->resolutionTime = $values['resolutionTime'] ?? null; + $this->timeToClose = $values['timeToClose'] ?? null; + } + + /** + * @return ?int + */ + public function getFirstReplyTime(): ?int + { + return $this->firstReplyTime; + } + + /** + * @param ?int $value + */ + public function setFirstReplyTime(?int $value = null): self + { + $this->firstReplyTime = $value; + return $this; + } + + /** + * @return ?int + */ + public function getNextReplyTime(): ?int + { + return $this->nextReplyTime; + } + + /** + * @param ?int $value + */ + public function setNextReplyTime(?int $value = null): self + { + $this->nextReplyTime = $value; + return $this; + } + + /** + * @return ?int + */ + public function getResolutionTime(): ?int + { + return $this->resolutionTime; + } + + /** + * @param ?int $value + */ + public function setResolutionTime(?int $value = null): self + { + $this->resolutionTime = $value; + return $this; + } + + /** + * @return ?int + */ + public function getTimeToClose(): ?int + { + return $this->timeToClose; + } + + /** + * @param ?int $value + */ + public function setTimeToClose(?int $value = null): self + { + $this->timeToClose = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationSlaPaused.php b/src/Unstable/Types/ConversationSlaPaused.php new file mode 100644 index 0000000..68df27b --- /dev/null +++ b/src/Unstable/Types/ConversationSlaPaused.php @@ -0,0 +1,105 @@ +conversation_sla_paused. + */ +class ConversationSlaPaused extends JsonSerializableType +{ + /** + * @var ?string $slaName Name of the SLA being paused + */ + #[JsonProperty('sla_name')] + private ?string $slaName; + + /** + * @var ?value-of $currentSlaStatus Overall SLA status at pause time + */ + #[JsonProperty('current_sla_status')] + private ?string $currentSlaStatus; + + /** + * @var ?array $slaStates Status of all SLA targets at pause time + */ + #[JsonProperty('sla_states'), ArrayType(['string' => ConversationSlaPausedSlaStatesValue::class])] + private ?array $slaStates; + + /** + * @param array{ + * slaName?: ?string, + * currentSlaStatus?: ?value-of, + * slaStates?: ?array, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->slaName = $values['slaName'] ?? null; + $this->currentSlaStatus = $values['currentSlaStatus'] ?? null; + $this->slaStates = $values['slaStates'] ?? null; + } + + /** + * @return ?string + */ + public function getSlaName(): ?string + { + return $this->slaName; + } + + /** + * @param ?string $value + */ + public function setSlaName(?string $value = null): self + { + $this->slaName = $value; + return $this; + } + + /** + * @return ?value-of + */ + public function getCurrentSlaStatus(): ?string + { + return $this->currentSlaStatus; + } + + /** + * @param ?value-of $value + */ + public function setCurrentSlaStatus(?string $value = null): self + { + $this->currentSlaStatus = $value; + return $this; + } + + /** + * @return ?array + */ + public function getSlaStates(): ?array + { + return $this->slaStates; + } + + /** + * @param ?array $value + */ + public function setSlaStates(?array $value = null): self + { + $this->slaStates = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationSlaPausedCurrentSlaStatus.php b/src/Unstable/Types/ConversationSlaPausedCurrentSlaStatus.php new file mode 100644 index 0000000..f2641d9 --- /dev/null +++ b/src/Unstable/Types/ConversationSlaPausedCurrentSlaStatus.php @@ -0,0 +1,11 @@ +status = $values['status'] ?? null; + $this->secondsRemaining = $values['secondsRemaining'] ?? null; + } + + /** + * @return ?'paused' + */ + public function getStatus(): ?string + { + return $this->status; + } + + /** + * @param ?'paused' $value + */ + public function setStatus(?string $value = null): self + { + $this->status = $value; + return $this; + } + + /** + * @return ?int + */ + public function getSecondsRemaining(): ?int + { + return $this->secondsRemaining; + } + + /** + * @param ?int $value + */ + public function setSecondsRemaining(?int $value = null): self + { + $this->secondsRemaining = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationSlaRemoved.php b/src/Unstable/Types/ConversationSlaRemoved.php new file mode 100644 index 0000000..a446c62 --- /dev/null +++ b/src/Unstable/Types/ConversationSlaRemoved.php @@ -0,0 +1,54 @@ +conversation_sla_removed. + */ +class ConversationSlaRemoved extends JsonSerializableType +{ + /** + * @var ?string $slaName Name of the SLA that was removed + */ + #[JsonProperty('sla_name')] + private ?string $slaName; + + /** + * @param array{ + * slaName?: ?string, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->slaName = $values['slaName'] ?? null; + } + + /** + * @return ?string + */ + public function getSlaName(): ?string + { + return $this->slaName; + } + + /** + * @param ?string $value + */ + public function setSlaName(?string $value = null): self + { + $this->slaName = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationSlaTargetMissed.php b/src/Unstable/Types/ConversationSlaTargetMissed.php new file mode 100644 index 0000000..f2d7213 --- /dev/null +++ b/src/Unstable/Types/ConversationSlaTargetMissed.php @@ -0,0 +1,130 @@ +conversation_sla_target_missed. + */ +class ConversationSlaTargetMissed extends JsonSerializableType +{ + /** + * @var ?string $slaName Name of the SLA + */ + #[JsonProperty('sla_name')] + private ?string $slaName; + + /** + * @var ?value-of $slaTargetType Which specific target was missed + */ + #[JsonProperty('sla_target_type')] + private ?string $slaTargetType; + + /** + * @var ?value-of $currentSlaStatus Overall SLA status + */ + #[JsonProperty('current_sla_status')] + private ?string $currentSlaStatus; + + /** + * @var ?array $slaStates Status of all SLA targets at the time of breach + */ + #[JsonProperty('sla_states'), ArrayType(['string' => ConversationSlaTargetMissedSlaStatesValue::class])] + private ?array $slaStates; + + /** + * @param array{ + * slaName?: ?string, + * slaTargetType?: ?value-of, + * currentSlaStatus?: ?value-of, + * slaStates?: ?array, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->slaName = $values['slaName'] ?? null; + $this->slaTargetType = $values['slaTargetType'] ?? null; + $this->currentSlaStatus = $values['currentSlaStatus'] ?? null; + $this->slaStates = $values['slaStates'] ?? null; + } + + /** + * @return ?string + */ + public function getSlaName(): ?string + { + return $this->slaName; + } + + /** + * @param ?string $value + */ + public function setSlaName(?string $value = null): self + { + $this->slaName = $value; + return $this; + } + + /** + * @return ?value-of + */ + public function getSlaTargetType(): ?string + { + return $this->slaTargetType; + } + + /** + * @param ?value-of $value + */ + public function setSlaTargetType(?string $value = null): self + { + $this->slaTargetType = $value; + return $this; + } + + /** + * @return ?value-of + */ + public function getCurrentSlaStatus(): ?string + { + return $this->currentSlaStatus; + } + + /** + * @param ?value-of $value + */ + public function setCurrentSlaStatus(?string $value = null): self + { + $this->currentSlaStatus = $value; + return $this; + } + + /** + * @return ?array + */ + public function getSlaStates(): ?array + { + return $this->slaStates; + } + + /** + * @param ?array $value + */ + public function setSlaStates(?array $value = null): self + { + $this->slaStates = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationSlaTargetMissedCurrentSlaStatus.php b/src/Unstable/Types/ConversationSlaTargetMissedCurrentSlaStatus.php new file mode 100644 index 0000000..05f1116 --- /dev/null +++ b/src/Unstable/Types/ConversationSlaTargetMissedCurrentSlaStatus.php @@ -0,0 +1,12 @@ + $status Status of this specific target + */ + #[JsonProperty('status')] + private ?string $status; + + /** + * @var ?int $secondsRemaining Time remaining for active/paused targets (null for hit/missed) + */ + #[JsonProperty('seconds_remaining')] + private ?int $secondsRemaining; + + /** + * @param array{ + * status?: ?value-of, + * secondsRemaining?: ?int, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->status = $values['status'] ?? null; + $this->secondsRemaining = $values['secondsRemaining'] ?? null; + } + + /** + * @return ?value-of + */ + public function getStatus(): ?string + { + return $this->status; + } + + /** + * @param ?value-of $value + */ + public function setStatus(?string $value = null): self + { + $this->status = $value; + return $this; + } + + /** + * @return ?int + */ + public function getSecondsRemaining(): ?int + { + return $this->secondsRemaining; + } + + /** + * @param ?int $value + */ + public function setSecondsRemaining(?int $value = null): self + { + $this->secondsRemaining = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationSlaTargetMissedSlaStatesValueStatus.php b/src/Unstable/Types/ConversationSlaTargetMissedSlaStatesValueStatus.php new file mode 100644 index 0000000..01ab9ce --- /dev/null +++ b/src/Unstable/Types/ConversationSlaTargetMissedSlaStatesValueStatus.php @@ -0,0 +1,11 @@ +conversation_sla_unpaused. + */ +class ConversationSlaUnpaused extends JsonSerializableType +{ + /** + * @var ?string $slaName Name of the SLA being unpaused + */ + #[JsonProperty('sla_name')] + private ?string $slaName; + + /** + * @param array{ + * slaName?: ?string, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->slaName = $values['slaName'] ?? null; + } + + /** + * @return ?string + */ + public function getSlaName(): ?string + { + return $this->slaName; + } + + /** + * @param ?string $value + */ + public function setSlaName(?string $value = null): self + { + $this->slaName = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/ConversationTagsUpdated.php b/src/Unstable/Types/ConversationTagsUpdated.php new file mode 100644 index 0000000..f1ee2ad --- /dev/null +++ b/src/Unstable/Types/ConversationTagsUpdated.php @@ -0,0 +1,80 @@ +conversation_tags_updated. + */ +class ConversationTagsUpdated extends JsonSerializableType +{ + /** + * @var ?array $tagsAdded Array of tag names that were added + */ + #[JsonProperty('tags_added'), ArrayType(['string'])] + private ?array $tagsAdded; + + /** + * @var ?array $tagsRemoved Array of tag names that were removed + */ + #[JsonProperty('tags_removed'), ArrayType(['string'])] + private ?array $tagsRemoved; + + /** + * @param array{ + * tagsAdded?: ?array, + * tagsRemoved?: ?array, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->tagsAdded = $values['tagsAdded'] ?? null; + $this->tagsRemoved = $values['tagsRemoved'] ?? null; + } + + /** + * @return ?array + */ + public function getTagsAdded(): ?array + { + return $this->tagsAdded; + } + + /** + * @param ?array $value + */ + public function setTagsAdded(?array $value = null): self + { + $this->tagsAdded = $value; + return $this; + } + + /** + * @return ?array + */ + public function getTagsRemoved(): ?array + { + return $this->tagsRemoved; + } + + /** + * @param ?array $value + */ + public function setTagsRemoved(?array $value = null): self + { + $this->tagsRemoved = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/PriorityChanged.php b/src/Unstable/Types/PriorityChanged.php new file mode 100644 index 0000000..5d7ac57 --- /dev/null +++ b/src/Unstable/Types/PriorityChanged.php @@ -0,0 +1,79 @@ +priority_changed. + */ +class PriorityChanged extends JsonSerializableType +{ + /** + * @var ?value-of $currentPriority Current priority state + */ + #[JsonProperty('current_priority')] + private ?string $currentPriority; + + /** + * @var ?value-of $previousPriority Previous priority state + */ + #[JsonProperty('previous_priority')] + private ?string $previousPriority; + + /** + * @param array{ + * currentPriority?: ?value-of, + * previousPriority?: ?value-of, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->currentPriority = $values['currentPriority'] ?? null; + $this->previousPriority = $values['previousPriority'] ?? null; + } + + /** + * @return ?value-of + */ + public function getCurrentPriority(): ?string + { + return $this->currentPriority; + } + + /** + * @param ?value-of $value + */ + public function setCurrentPriority(?string $value = null): self + { + $this->currentPriority = $value; + return $this; + } + + /** + * @return ?value-of + */ + public function getPreviousPriority(): ?string + { + return $this->previousPriority; + } + + /** + * @param ?value-of $value + */ + public function setPreviousPriority(?string $value = null): self + { + $this->previousPriority = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +} diff --git a/src/Unstable/Types/PriorityChangedCurrentPriority.php b/src/Unstable/Types/PriorityChangedCurrentPriority.php new file mode 100644 index 0000000..1bf5b94 --- /dev/null +++ b/src/Unstable/Types/PriorityChangedCurrentPriority.php @@ -0,0 +1,9 @@ +snoozed. + */ +class Snoozed extends JsonSerializableType +{ + /** + * @var ?string $until Human-readable description of snooze duration + */ + #[JsonProperty('until')] + private ?string $until; + + /** + * @var ?DateTime $customUntilTime ISO timestamp for custom snooze times (null for general snoozes) + */ + #[JsonProperty('custom_until_time'), Date(Date::TYPE_DATETIME)] + private ?DateTime $customUntilTime; + + /** + * @param array{ + * until?: ?string, + * customUntilTime?: ?DateTime, + * } $values + */ + public function __construct( + array $values = [], + ) { + $this->until = $values['until'] ?? null; + $this->customUntilTime = $values['customUntilTime'] ?? null; + } + + /** + * @return ?string + */ + public function getUntil(): ?string + { + return $this->until; + } + + /** + * @param ?string $value + */ + public function setUntil(?string $value = null): self + { + $this->until = $value; + return $this; + } + + /** + * @return ?DateTime + */ + public function getCustomUntilTime(): ?DateTime + { + return $this->customUntilTime; + } + + /** + * @param ?DateTime $value + */ + public function setCustomUntilTime(?DateTime $value = null): self + { + $this->customUntilTime = $value; + return $this; + } + + /** + * @return string + */ + public function __toString(): string + { + return $this->toJson(); + } +}